-StoredCollection (Oracle - Berkeley DB Java API) -

java.lang.Object
+
- com.sleepycat.collections.StoredContainer
- +
  - com.sleepycat.collections.StoredCollection<E>
  +
+

+
+
All Implemented Interfaces:
+
java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>
+
+
+
Direct Known Subclasses:
+
StoredEntrySet, StoredKeySet, StoredList, StoredValueSet
+
+
+
+
```
public abstract class StoredCollection<E>
+extends StoredContainer
+implements java.util.Collection<E>
```
+
A abstract base class for all stored collections. This class, and its + base class StoredContainer, provide implementations of most methods + in the Collection interface. Other methods, such as add(java.lang.Object, java.lang.Object) + and Collection.remove(java.lang.Object), are provided by concrete classes that extend this class.
In addition, this class provides the following methods for stored collections only. Note that the use of these methods is not compatible with the standard Java collections interface.
-
- -
-
- -
+
getIteratorBlockSize()
setIteratorBlockSize(int)
storedIterator()
storedIterator(boolean)
join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)
toList()

+ + +

- - - - - - - - - - -

-Field Summary
-`static int`	`DEFAULT_ITERATOR_BLOCK_SIZE` - - - The default number of records read at one time by iterators.

- +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static int DEFAULT_ITERATOR_BLOCK_SIZE +
The default number of records read at one time by iterators.
+
+

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ITERATOR_BLOCK_SIZE` + The default number of records read at one time by iterators. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-Method Summary

- boolean addAll(Collection<? extends E> coll) - -
- Adds all of the elements in the specified collection to this collection - (optional operation).

- boolean containsAll(Collection<?> coll) - -
- Returns true if this collection contains all of the elements in the - specified collection.

- boolean equals(Object other) - -
- Compares the specified object with this collection for equality.

- int getIteratorBlockSize() - -
- Returns the number of records read at one time by iterators returned by - the iterator() method.

- int hashCode() - -
-

- Iterator<E> iterator() - -
- Returns an iterator over the elements in this collection.

- StoredIterator<E>

iterator(boolean writeAllowed) - -
- Deprecated. Please use storedIterator() or storedIterator(boolean) instead. Because the iterator returned must +

+ + +
Method Summary
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Methods
Modifier and Type Method and Description
boolean addAll(java.util.Collection<? extends E> coll) +
Adds all of the elements in the specified collection to this collection + (optional operation).
+
boolean containsAll(java.util.Collection<?> coll) +
Returns true if this collection contains all of the elements in the + specified collection.
+
boolean equals(java.lang.Object other) +
Compares the specified object with this collection for equality.
+
int getIteratorBlockSize() +
Returns the number of records read at one time by iterators returned by + the iterator() method.
+
int hashCode()
java.util.Iterator<E> iterator() +
Returns an iterator over the elements in this collection.
+
StoredIterator<E> iterator(boolean writeAllowed) +
Deprecated. +
Please use storedIterator() or storedIterator(boolean) instead. Because the iterator returned must be closed, the method name iterator is confusing since standard - Java iterators do not need to be closed.
- StoredIterator<E> join(StoredContainer[] indices, - Object[] indexKeys, - JoinConfig joinConfig) - -
-          Returns an iterator representing an equality join of the indices and - index key values specified.
- boolean removeAll(Collection<?> coll) - -
-          Removes all this collection's elements that are also contained in the - specified collection (optional operation).
- boolean retainAll(Collection<?> coll) - -
-          Retains only the elements in this collection that are contained in the - specified collection (optional operation).
- void setIteratorBlockSize(int blockSize) - -
-          Changes the number of records read at one time by iterators returned by - the iterator() method.
- int size() - -
-          Returns a non-transactional count of the records in the collection or - map.
- StoredIterator<E> storedIterator() - -
-          Returns an iterator over the elements in this collection.
- StoredIterator<E> storedIterator(boolean writeAllowed) - -
-          Returns a read or read-write iterator over the elements in this - collection.
- Object[] toArray() - -
-          Returns an array of all the elements in this collection.
-- - - - - -<T> T[] - toArray(T[] a) - -
-          Returns an array of all the elements in this collection whose runtime - type is that of the specified array.
- List<E> toList() - -
-          Returns a copy of this collection as an ArrayList.
- String toString() - -
-          Converts the collection to a string representation for debugging.
- - - - - - - - -
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.Collection
add, clear, contains, isEmpty, remove
- -

- + Java iterators do not need to be closed. + +

StoredIterator<E>

join(StoredContainer[] indices,
+    java.lang.Object[] indexKeys,
+    JoinConfig joinConfig)

Returns an iterator representing an equality join of the indices and + index key values specified.

boolean

removeAll(java.util.Collection<?> coll) +

Removes all this collection's elements that are also contained in the + specified collection (optional operation).

boolean

retainAll(java.util.Collection<?> coll) +

Retains only the elements in this collection that are contained in the + specified collection (optional operation).

void

setIteratorBlockSize(int blockSize) +

Changes the number of records read at one time by iterators returned by + the iterator() method.

int

size() +

Returns a non-transactional count of the records in the collection or + map.

StoredIterator<E>

storedIterator() +

Returns an iterator over the elements in this collection.

StoredIterator<E>

storedIterator(boolean writeAllowed) +

Returns a read or read-write iterator over the elements in this + collection.

java.lang.Object[]

toArray() +

Returns an array of all the elements in this collection.

<T> T[]

toArray(T[] a) +

Returns an array of all the elements in this collection whose runtime + type is that of the specified array.

java.util.List<E>

toList() +

Returns a copy of this collection as an ArrayList.

java.lang.String

toString() +

Converts the collection to a string representation for debugging.

+ + +
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.Collection
+add, clear, contains, isEmpty, remove

+ + +

- - - - - - -
-Field Detail
- -
-DEFAULT_ITERATOR_BLOCK_SIZE
-
```
-public static final int DEFAULT_ITERATOR_BLOCK_SIZE
```
-
-
The default number of records read at one time by iterators. -
-
-
See Also:
setIteratorBlockSize(int), -Constant Field Values
-
- +
- + + +
  Field Detail
  + + + +
  - +
    DEFAULT_ITERATOR_BLOCK_SIZE
    +
```
public static final int DEFAULT_ITERATOR_BLOCK_SIZE
```
    +
    The default number of records read at one time by iterators.
    +
    See Also:
    setIteratorBlockSize(int), +Constant Field Values
    +
  +
- - - - - - -
-Method Detail
- -
-getIteratorBlockSize
-
```
-public int getIteratorBlockSize()
```
-
-
Returns the number of records read at one time by iterators returned by - the iterator() method. By default this value is DEFAULT_ITERATOR_BLOCK_SIZE. -
-
-
-
-
-
-
-
-
- -
-setIteratorBlockSize
-
```
-public void setIteratorBlockSize(int blockSize)
```
-
-
Changes the number of records read at one time by iterators returned by - the iterator() method. By default this value is DEFAULT_ITERATOR_BLOCK_SIZE. -
-
-
-
-
- -
Throws: -
IllegalArgumentException - if the blockSize is less than two.
-
-
-
- -
-iterator
-
```
-public Iterator<E> iterator()
```
-
-
Returns an iterator over the elements in this collection. +
- + + +
  Method Detail
  + + + +
  - +
    getIteratorBlockSize
    +
    public int getIteratorBlockSize()
    +
    Returns the number of records read at one time by iterators returned by + the iterator() method. By default this value is DEFAULT_ITERATOR_BLOCK_SIZE.
    +
  + + + +
  - +
    setIteratorBlockSize
    +
    public void setIteratorBlockSize(int blockSize)
    +
    Changes the number of records read at one time by iterators returned by + the iterator() method. By default this value is DEFAULT_ITERATOR_BLOCK_SIZE.
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if the blockSize is less than two.
    +
  + + + +
  - +
    iterator
    +
    public java.util.Iterator<E> iterator()
    +
    Returns an iterator over the elements in this collection. The iterator will be read-only if the collection is read-only. - This method conforms to the Collection.iterator() interface. + This method conforms to the Collection.iterator() interface.
    The iterator returned by this method does not keep a database cursor open and therefore it does not need to be closed. It reads blocks of records as needed, opening and closing a cursor to read each block of records. The number of records per block is 10 by default and can be - changed with setIteratorBlockSize(int).
    + changed with setIteratorBlockSize(int).
    
    Because this iterator does not keep a cursor open, if it is used without transactions, the iterator does not have cursor stability characteristics. In other words, the record at the current iterator position can be changed or deleted by another thread. To prevent this from happening, call this method within a transaction or - use the storedIterator() method instead.
    -
    -
    -
    Specified by:
    iterator in interface Iterable<E>
    Specified by:
    iterator in interface Collection<E>
    -
    -
    - -
    Returns:
    a standard Iterator for this collection.
    See Also:
    StoredContainer.isWriteAllowed()
    -
    -
-
- -
-storedIterator
-
```
-public StoredIterator<E> storedIterator()
```
-
-
Returns an iterator over the elements in this collection. + use the storedIterator() method instead.

- -com.sleepycat.collections - -Class StoredCollection<E>

Class StoredCollection<E>

Field Summary

Method Summary

Methods inherited from class com.sleepycat.collections.StoredContainer

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

-DEFAULT_ITERATOR_BLOCK_SIZE

Field Detail

DEFAULT_ITERATOR_BLOCK_SIZE

-getIteratorBlockSize

-setIteratorBlockSize

-iterator

Method Detail

getIteratorBlockSize

setIteratorBlockSize

iterator

-storedIterator

storedIterator

-storedIterator

storedIterator

-iterator

iterator

-toArray

-toArray

toArray

toArray

-containsAll

containsAll

-addAll

addAll

-removeAll

removeAll

-retainAll

retainAll

-equals

equals

-hashCode

-toList

-toString

-size

-join

hashCode

toList

toString

size

join

- -com.sleepycat.collections -
-Class StoredCollection<E>