From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- .../com/sleepycat/collections/StoredKeySet.html | 755 +++++++++++---------- 1 file changed, 380 insertions(+), 375 deletions(-) (limited to 'docs/java/com/sleepycat/collections/StoredKeySet.html') diff --git a/docs/java/com/sleepycat/collections/StoredKeySet.html b/docs/java/com/sleepycat/collections/StoredKeySet.html index f08ae6fc..98812aa1 100644 --- a/docs/java/com/sleepycat/collections/StoredKeySet.html +++ b/docs/java/com/sleepycat/collections/StoredKeySet.html @@ -1,408 +1,413 @@ - - - - - -StoredKeySet (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.collections -
-Class StoredKeySet<K>

-
-java.lang.Object
-  extended by com.sleepycat.collections.StoredContainer
-      extended by com.sleepycat.collections.StoredCollection<K>
-          extended by com.sleepycat.collections.StoredKeySet<K>
-
-
-
All Implemented Interfaces:
Cloneable, Iterable<K>, Collection<K>, Set<K>
-
-
-
Direct Known Subclasses:
StoredSortedKeySet
-
-
-
-
public class StoredKeySet<K>
extends StoredCollection<K>
implements Set<K>
- - -

-The Set returned by Map.keySet() and which can also be constructed directly +

+
com.sleepycat.collections
+

Class StoredKeySet<K>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>
    +
    +
    +
    Direct Known Subclasses:
    +
    StoredSortedKeySet
    +
    +
    +
    +
    public class StoredKeySet<K>
+extends StoredCollection<K>
+implements java.util.Set<K>
    +
    The Set returned by Map.keySet() and which can also be constructed directly if a Map is not needed. Since this collection is a set it only contains one element for each key, even when duplicates are allowed. Key set iterators are therefore particularly useful for enumerating the unique keys of a store or index that - allows duplicates. -

    - -

    -

    - -

    + allows duplicates.

    +
    • +
+
+
+ +
+
+
    +
  • - - - - - - -
    -Constructor Detail
    - -

    -StoredKeySet

    -
    -public StoredKeySet(Database database,
-                    EntryBinding<K> keyBinding,
-                    boolean writeAllowed)
    -
    -
    Creates a key set view of a Database. -

    -

    -
    Parameters:
    database - is the Database underlying the new collection.
    keyBinding - is the binding used to translate between key buffers - and key 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 checked exception is thrown, - including a DatabaseException on BDB (C Edition).
    -
    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredKeySet

        +
        public StoredKeySet(Database database,
+            EntryBinding<K> keyBinding,
+            boolean writeAllowed)
        +
        Creates a key set view of a Database.
        +
        Parameters:
        database - is the Database underlying the new collection.
        keyBinding - is the binding used to translate between key buffers + and key objects.
        writeAllowed - is true to create a read-write collection or false + to create a read-only collection.
        +
        Throws:
        +
        java.lang.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
    - -

    -add

    -
    -public boolean add(K key)
    -
    -
    Adds the specified key to this set if it is not already present +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

        +
        public boolean add(K key)
        +
        Adds the specified key to this set if it is not already present (optional operation). - This method conforms to the Set.add(E) interface. + This method conforms to the Set.add(E) interface.

        WARNING: When a key is added the value in the underlying data store will be empty, i.e., the byte array will be zero length. Such a record cannot be accessed using the Map interface unless the value binding - supports zero length byte arrays.

        -

        -

        -
        Specified by:
        add in interface Collection<K>
        Specified by:
        add in interface Set<K>
        -
        -
        - -
        Throws: -
        UnsupportedOperationException - if the collection is indexed, or - if the collection is read-only. -
        RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C Edition).
        -
        -
    -
    - -

    -remove

    -
    -public boolean remove(Object key)
    -
    -
    Removes the specified key from this set if it is present (optional + supports zero length byte arrays.

+
+
Specified by:
+
add in interface java.util.Collection<K>
+
Specified by:
+
add in interface java.util.Set<K>
+
Throws:
+
java.lang.UnsupportedOperationException - if the collection is indexed, or + if the collection is read-only.
+
RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C Edition).
+ + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1