From 836328ea2ca7c6780307abf258503201c91e5a96 Mon Sep 17 00:00:00 2001 From: lresende Date: Tue, 10 Nov 2009 19:20:03 +0000 Subject: moving SDO branches git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@834615 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/main/java/commonj/sdo/Sequence.java | 140 +++++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 sdo-java/branches/sdo-1.1.1-incubating/sdo-api/src/main/java/commonj/sdo/Sequence.java (limited to 'sdo-java/branches/sdo-1.1.1-incubating/sdo-api/src/main/java/commonj/sdo/Sequence.java') diff --git a/sdo-java/branches/sdo-1.1.1-incubating/sdo-api/src/main/java/commonj/sdo/Sequence.java b/sdo-java/branches/sdo-1.1.1-incubating/sdo-api/src/main/java/commonj/sdo/Sequence.java new file mode 100644 index 0000000000..d015633fa5 --- /dev/null +++ b/sdo-java/branches/sdo-1.1.1-incubating/sdo-api/src/main/java/commonj/sdo/Sequence.java @@ -0,0 +1,140 @@ +/** + * + * + * Service Data Objects + * Version 2.1.0 + * Licensed Materials + * + * (c) Copyright BEA Systems, Inc., International Business Machines Corporation, + * Oracle Corporation, Primeton Technologies Ltd., Rogue Wave Software, SAP AG., + * Software AG., Sun Microsystems, Sybase Inc., Xcalia, Zend Technologies, + * 2005, 2006. All rights reserved. + * + * + * + */ + +package commonj.sdo; + +/** + * A sequence is a heterogeneous list of {@link Property properties} and corresponding values. + * It represents an ordered arbitrary mixture of data values from more than one property of a {@link DataObject data object}. + */ +public interface Sequence +{ + /** + * Returns the number of entries in the sequence. + * @return the number of entries. + */ + int size(); + + /** + * Returns the property for the given entry index. + * Returns null for mixed text entries. + * @param index the index of the entry. + * @return the property or null for the given entry index. + */ + Property getProperty(int index); + + /** + * Returns the property value for the given entry index. + * @param index the index of the entry. + * @return the value for the given entry index. + */ + Object getValue(int index); + + /** + * Sets the entry at a specified index to the new value. + * @param index the index of the entry. + * @param value the new value for the entry. + */ + Object setValue(int index, Object value); + + /** + * Adds a new entry with the specified property name and value + * to the end of the entries. + * @param propertyName the name of the entry's property. + * @param value the value for the entry. + */ + boolean add(String propertyName, Object value); + + /** + * Adds a new entry with the specified property index and value + * to the end of the entries. + * @param propertyIndex the index of the entry's property. + * @param value the value for the entry. + */ + boolean add(int propertyIndex, Object value); + + /** + * Adds a new entry with the specified property and value + * to the end of the entries. + * @param property the property of the entry. + * @param value the value for the entry. + */ + boolean add(Property property, Object value); + + /** + * Adds a new entry with the specified property name and value + * at the specified entry index. + * @param index the index at which to add the entry. + * @param propertyName the name of the entry's property. + * @param value the value for the entry. + */ + void add(int index, String propertyName, Object value); + + /** + * Adds a new entry with the specified property index and value + * at the specified entry index. + * @param index the index at which to add the entry. + * @param propertyIndex the index of the entry's property. + * @param value the value for the entry. + */ + void add(int index, int propertyIndex, Object value); + + /** + * Adds a new entry with the specified property and value + * at the specified entry index. + * @param index the index at which to add the entry. + * @param property the property of the entry. + * @param value the value for the entry. + */ + void add(int index, Property property, Object value); + + /** + * Removes the entry at the given entry index. + * @param index the index of the entry. + */ + void remove(int index); + + /** + * Moves the entry at fromIndex to toIndex. + * @param toIndex the index of the entry destination. + * @param fromIndex the index of the entry to move. + */ + void move(int toIndex, int fromIndex); + + /** + * @deprecated replaced by {@link #addText(String)} in 2.1.0 + */ + void add(String text); + + /** + * @deprecated replaced by {@link #addText(int, String)} in 2.1.0 + */ + void add(int index, String text); + + /** + * Adds a new text entry to the end of the Sequence. + * @param text value of the entry. + */ + void addText(String text); + + /** + * Adds a new text entry at the given index. + * @param index the index at which to add the entry. + * @param text value of the entry. + */ + void addText(int index, String text); + +} -- cgit v1.2.3