From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../com/amazon/carbonado/util/AbstractPool.html | 348 +++++++++++++++++++++ 1 file changed, 348 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/util/AbstractPool.html (limited to 'apidocs/com/amazon/carbonado/util/AbstractPool.html') diff --git a/apidocs/com/amazon/carbonado/util/AbstractPool.html b/apidocs/com/amazon/carbonado/util/AbstractPool.html new file mode 100644 index 0000000..55e0910 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AbstractPool.html @@ -0,0 +1,348 @@ + + + + + + +AbstractPool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AbstractPool<K,V,E extends java.lang.Exception>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    SequenceValueProducerPool, StoragePool
    +
    +
    +
    +
    public abstract class AbstractPool<K,V,E extends java.lang.Exception>
+extends java.lang.Object
    +
    A concurrent pool of strongly referenced values mapped by key. Values are + lazily created and pooled.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractPool() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      protected abstract Vcreate(K key) +
      Return a new value instance.
      +
      Vget(K key) +
      Returns a value for the given key, which is lazily created and + pooled.
      +
      Vremove(java.lang.Object key) +
      Remove a value, returning the old value.
      +
      java.util.Collection<V>values() +
      Returns the pool values, which may be concurrently modified.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractPool

        +
        protected AbstractPool()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public V get(K key)
+      throws E extends java.lang.Exception
        +
        Returns a value for the given key, which is lazily created and + pooled. If multiple threads are requesting upon the same key + concurrently, at most one thread attempts to lazily create the + value. The others wait for it to become available.
        +
        Throws:
        +
        E extends java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public V remove(java.lang.Object key)
        +
        Remove a value, returning the old value.
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<V> values()
        +
        Returns the pool values, which may be concurrently modified.
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        • +
      + + + + + +
        +
      • +

        create

        +
        protected abstract V create(K key)
+                     throws E extends java.lang.Exception
        +
        Return a new value instance.
        +
        Throws:
        +
        E extends java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3