com.sleepycat.collections
public class StoredList extends StoredCollection implements List
For all stored lists the keys of the underlying Database must have record number format, and therefore the store or index must be a RECNO, RECNO-RENUMBER, QUEUE, or BTREE-RECNUM database. Only RECNO-RENUMBER allows true list behavior where record numbers are renumbered following the position of an element that is added or removed. For the other access methods (RECNO, QUEUE, and BTREE-RECNUM), stored Lists are most useful as read-only collections where record numbers are not required to be sequential.
In addition to the standard List methods, this class provides the following methods for stored lists only. Note that the use of these methods is not compatible with the standard Java collections interface.
Constructor Summary | |
---|---|
StoredList(Database database, EntryBinding valueBinding, boolean writeAllowed)
Creates a list view of a Database.
| |
StoredList(Database database, EntityBinding valueEntityBinding, boolean writeAllowed)
Creates a list entity view of a Database.
| |
StoredList(Database database, EntryBinding valueBinding, PrimaryKeyAssigner keyAssigner)
Creates a list view of a Database with a PrimaryKeyAssigner. | |
StoredList(Database database, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)
Creates a list entity view of a Database with a PrimaryKeyAssigner. |
Method Summary | |
---|---|
void | add(int index, Object value)
Inserts the specified element at the specified position in this list
(optional operation).
|
boolean | add(Object value)
Appends the specified element to the end of this list (optional
operation).
|
boolean | addAll(int index, Collection coll)
Inserts all of the elements in the specified collection into this list
at the specified position (optional operation).
|
int | append(Object value)
Appends a given value returning the newly assigned index.
|
boolean | contains(Object value)
Returns true if this list contains the specified element.
|
boolean | equals(Object other)
Compares the specified object with this list for equality.
|
Object | get(int index)
Returns the element at the specified position in this list.
|
int | hashCode() |
int | indexOf(Object value)
Returns the index in this list of the first occurrence of the specified
element, or -1 if this list does not contain this element.
|
int | lastIndexOf(Object value)
Returns the index in this list of the last occurrence of the specified
element, or -1 if this list does not contain this element.
|
ListIterator | listIterator()
Returns a list iterator of the elements in this list (in proper
sequence).
|
ListIterator | listIterator(int index)
Returns a list iterator of the elements in this list (in proper
sequence), starting at the specified position in this list.
|
Object | remove(int index)
Removes the element at the specified position in this list (optional
operation).
|
boolean | remove(Object value)
Removes the first occurrence in this list of the specified element
(optional operation).
|
Object | set(int index, Object value)
Replaces the element at the specified position in this list with the
specified element (optional operation).
|
List | subList(int fromIndex, int toIndex)
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
|
Parameters: database is the Database underlying the new collection. valueBinding is the binding used to translate between value buffers and value objects. writeAllowed is true to create a read-write collection or false to create a read-only collection.
Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.
Parameters: database is the Database underlying the new collection. valueEntityBinding is the binding used to translate between key/value buffers and entity value objects. writeAllowed is true to create a read-write collection or false to create a read-only collection.
Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.
Parameters: database is the Database underlying the new collection. valueBinding is the binding used to translate between value buffers and value objects. keyAssigner is used by the StoredList and StoredList methods to assign primary keys.
Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.
Parameters: database is the Database underlying the new collection. valueEntityBinding is the binding used to translate between key/value buffers and entity value objects. keyAssigner is used by the StoredList and StoredList methods to assign primary keys.
Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: UnsupportedOperationException if the collection is a sublist, or if the collection is indexed, or if the collection is read-only, or if the RECNO-RENUMBER access method was not used. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: UnsupportedOperationException if the collection is a sublist, or if the collection is indexed, or if the collection is read-only, or if the RECNO-RENUMBER access method was not used. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: UnsupportedOperationException if the collection is a sublist, or if the collection is indexed, or if the collection is read-only, or if the RECNO-RENUMBER access method was not used. RuntimeExceptionWrapper if a DatabaseException is thrown.
Parameters: value the value to be appended.
Returns: the assigned index.
Throws: UnsupportedOperationException if the collection is indexed, or if the collection is read-only, or if the Store has no PrimaryKeyAssigner and is not a QUEUE or RECNO database. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
For information on cursor stability and iterator block size, see StoredList.
Returns: a ListIterator for this collection.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
See Also: StoredList
For information on cursor stability and iterator block size, see StoredList.
Returns: a ListIterator for this collection.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.
See Also: StoredList
Throws: UnsupportedOperationException if the collection is a sublist, or if the collection is read-only. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: UnsupportedOperationException if the collection is a sublist, or if the collection is read-only. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: UnsupportedOperationException if the collection is indexed, or if the collection is read-only. IllegalArgumentException if an entity value binding is used and the primary key of the value given is different than the existing stored primary key. RuntimeExceptionWrapper if a DatabaseException is thrown.
Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.