|
Berkeley DB version 5.3.21 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredCollection<E>
com.sleepycat.collections.StoredList<E>
public class StoredList<E>
A List view of a Database
.
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.
Field Summary |
---|
Fields inherited from class com.sleepycat.collections.StoredCollection |
---|
DEFAULT_ITERATOR_BLOCK_SIZE |
Constructor Summary | |
---|---|
StoredList(Database database,
EntityBinding<E> valueEntityBinding,
boolean writeAllowed)
Creates a list entity view of a Database . |
|
StoredList(Database database,
EntityBinding<E> valueEntityBinding,
PrimaryKeyAssigner keyAssigner)
Creates a list entity view of a Database with a PrimaryKeyAssigner . |
|
StoredList(Database database,
EntryBinding<E> valueBinding,
boolean writeAllowed)
Creates a list view of a Database . |
|
StoredList(Database database,
EntryBinding<E> valueBinding,
PrimaryKeyAssigner keyAssigner)
Creates a list view of a Database with a PrimaryKeyAssigner . |
Method Summary | |
---|---|
boolean |
add(E value)
Appends the specified element to the end of this list (optional operation). |
void |
add(int index,
E value)
Inserts the specified element at the specified position in this list (optional operation). |
boolean |
addAll(int index,
Collection<? extends E> coll)
Inserts all of the elements in the specified collection into this list at the specified position (optional operation). |
int |
append(E 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. |
E |
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<E> |
listIterator()
Returns a list iterator of the elements in this list (in proper sequence). |
ListIterator<E> |
listIterator(int index)
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. |
E |
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). |
E |
set(int index,
E value)
Replaces the element at the specified position in this list with the specified element (optional operation). |
List<E> |
subList(int fromIndex,
int toIndex)
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. |
Methods inherited from class com.sleepycat.collections.StoredCollection |
---|
addAll, containsAll, getIteratorBlockSize, iterator, iterator, join, removeAll, retainAll, setIteratorBlockSize, size, storedIterator, storedIterator, toArray, toArray, toList, toString |
Methods inherited from class com.sleepycat.collections.StoredContainer |
---|
areDuplicatesAllowed, areDuplicatesOrdered, areKeyRangesAllowed, areKeysRenumbered, clear, getCursorConfig, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
addAll, clear, containsAll, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray |
Constructor Detail |
---|
public StoredList(Database database, EntryBinding<E> valueBinding, boolean writeAllowed)
Database
.
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.
IllegalArgumentException
- if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public StoredList(Database database, EntityBinding<E> valueEntityBinding, boolean writeAllowed)
Database
.
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.
IllegalArgumentException
- if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public StoredList(Database database, EntryBinding<E> valueBinding, PrimaryKeyAssigner keyAssigner)
Database
with a PrimaryKeyAssigner
. Writing is allowed for the created list.
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 add(int, E)
and append(E)
methods to assign primary keys.
IllegalArgumentException
- if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public StoredList(Database database, EntityBinding<E> valueEntityBinding, PrimaryKeyAssigner keyAssigner)
Database
with a PrimaryKeyAssigner
. Writing is allowed for the created list.
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 add(int, E)
and append(E)
methods to assign primary keys.
IllegalArgumentException
- if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).Method Detail |
---|
public void add(int index, E value)
List.add(int, Object)
interface.
add
in interface List<E>
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 checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public boolean add(E value)
List.add(Object)
interface.
add
in interface Collection<E>
add
in interface List<E>
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 checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public int append(E value)
PrimaryKeyAssigner
is associated
with Store for this list, it will be used to assigned the returned
index. Otherwise the Store must be a QUEUE or RECNO database and the
next available record number is assigned as the index. This method does
not exist in the standard List
interface.
value
- the value to be appended.
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 checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public boolean addAll(int index, Collection<? extends E> coll)
List.addAll(int, Collection)
interface.
addAll
in interface List<E>
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 checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public boolean contains(Object value)
List.contains(java.lang.Object)
interface.
contains
in interface Collection<E>
contains
in interface List<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public E get(int index)
List.get(int)
interface.
get
in interface List<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public int indexOf(Object value)
List.indexOf(java.lang.Object)
interface.
indexOf
in interface List<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public int lastIndexOf(Object value)
List.lastIndexOf(java.lang.Object)
interface.
lastIndexOf
in interface List<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public ListIterator<E> listIterator()
List.listIterator()
interface.
For information on cursor stability and iterator block size, see
StoredCollection.iterator()
.
listIterator
in interface List<E>
ListIterator
for this collection.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).StoredContainer.isWriteAllowed()
public ListIterator<E> listIterator(int index)
List.listIterator(int)
interface.
For information on cursor stability and iterator block size, see
StoredCollection.iterator()
.
listIterator
in interface List<E>
ListIterator
for this collection.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).StoredContainer.isWriteAllowed()
public E remove(int index)
List.remove(int)
interface.
remove
in interface List<E>
UnsupportedOperationException
- if the collection is a sublist, or
if the collection is read-only.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public boolean remove(Object value)
List.remove(Object)
interface.
remove
in interface Collection<E>
remove
in interface List<E>
UnsupportedOperationException
- if the collection is a sublist, or
if the collection is read-only.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public E set(int index, E value)
List.set(int, E)
interface.
set
in interface List<E>
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 checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public List<E> subList(int fromIndex, int toIndex)
List.subList(int, int)
interface.
subList
in interface List<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public boolean equals(Object other)
List.equals(java.lang.Object)
interface.
equals
in interface Collection<E>
equals
in interface List<E>
equals
in class StoredCollection<E>
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C Edition).public int hashCode()
hashCode
in interface Collection<E>
hashCode
in interface List<E>
hashCode
in class StoredCollection<E>
|
Berkeley DB version 5.3.21 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |