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/StoredValueSet.html | 819 +++++++++++---------- 1 file changed, 412 insertions(+), 407 deletions(-) (limited to 'docs/java/com/sleepycat/collections/StoredValueSet.html') diff --git a/docs/java/com/sleepycat/collections/StoredValueSet.html b/docs/java/com/sleepycat/collections/StoredValueSet.html index c6e30165..ac689332 100644 --- a/docs/java/com/sleepycat/collections/StoredValueSet.html +++ b/docs/java/com/sleepycat/collections/StoredValueSet.html @@ -1,435 +1,440 @@ - - - - - -StoredValueSet (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
-Berkeley DB
version 5.3.21
-
- + + +
+ + +
+ + + - -
-

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

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

-The Set returned by Map.values() and Map.duplicates(), and which can also be +

+
com.sleepycat.collections
+

Class StoredValueSet<E>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
    +
    +
    +
    Direct Known Subclasses:
    +
    StoredSortedValueSet
    +
    +
    +
    +
    public class StoredValueSet<E>
    +extends StoredCollection<E>
    +implements java.util.Set<E>
    +
    The Set returned by Map.values() and Map.duplicates(), and which can also be constructed directly if a Map is not needed. Although this collection is a set it may contain duplicate values. Only if - an entity value binding is used are all elements guaranteed to be unique. -

    - -

    -


    - -

    + an entity value binding is used are all elements guaranteed to be unique.

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

    -StoredValueSet

    -
    -public StoredValueSet(Database database,
    -                      EntryBinding<E> valueBinding,
    -                      boolean writeAllowed)
    -
    -
    Creates a value set view of a Database. -

    -

    -
    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 checked exception is thrown, - including a DatabaseException on BDB (C Edition).
    -
    -
    - -

    -StoredValueSet

    -
    -public StoredValueSet(Database database,
    -                      EntityBinding<E> valueEntityBinding,
    -                      boolean writeAllowed)
    -
    -
    Creates a value set entity view of a Database. -

    -

    -
    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 checked exception is thrown, - including a DatabaseException on BDB (C Edition).
    -
    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredValueSet

        +
        public StoredValueSet(Database database,
        +              EntryBinding<E> valueBinding,
        +              boolean writeAllowed)
        +
        Creates a value set view of a Database.
        +
        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:
        +
        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).
        +
      • +
      + + + +
        +
      • +

        StoredValueSet

        +
        public StoredValueSet(Database database,
        +              EntityBinding<E> valueEntityBinding,
        +              boolean writeAllowed)
        +
        Creates a value set entity view of a Database.
        +
        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:
        +
        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(E entity)
    -
    -
    Adds the specified entity to this set if it is not already present +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

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

        -

        -
        Specified by:
        add in interface Collection<E>
        Specified by:
        add in interface Set<E>
        -
        -
        -
        Parameters:
        entity - is the entity to be added. -
        Returns:
        true if the entity was added, that is the key-value pair - represented by the entity was not previously present in the collection. -
        Throws: -
        UnsupportedOperationException - if the collection is read-only, - if the collection is indexed, or if an entity binding is not used. -
        RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C Edition).
        -
        -
    -
    - -

    -contains

    -
    -public boolean contains(Object value)
    -
    -
    Returns true if this set contains the specified element. - This method conforms to the Set.contains(java.lang.Object) - interface. -

    -

    -
    Specified by:
    contains in interface Collection<E>
    Specified by:
    contains in interface Set<E>
    -
    -
    -
    Parameters:
    value - the value to check. -
    Returns:
    whether the set contains the given value. -
    Throws: -
    RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C Edition).
    -
    -
    -
    - -

    -remove

    -
    -public boolean remove(Object value)
    -
    -
    Removes the specified value from this set if it is present (optional + This method conforms to the Set.add(E) interface.
+
+
Specified by:
+
add in interface java.util.Collection<E>
+
Specified by:
+
add in interface java.util.Set<E>
+
Parameters:
entity - is the entity to be added.
+
Returns:
true if the entity was added, that is the key-value pair + represented by the entity was not previously present in the collection.
+
Throws:
+
java.lang.UnsupportedOperationException - if the collection is read-only, + if the collection is indexed, or if an entity binding is not used.
+
RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C Edition).
+ + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
-Berkeley DB
version 5.3.21
-
- + + +
+ + +
+ + + - -
-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