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 --- .../carbonado/repo/map/MapRepositoryBuilder.html | 481 +++++++++++++++++++++ .../repo/map/class-use/MapRepositoryBuilder.html | 117 +++++ .../amazon/carbonado/repo/map/package-frame.html | 20 + .../amazon/carbonado/repo/map/package-summary.html | 147 +++++++ .../amazon/carbonado/repo/map/package-tree.html | 134 ++++++ .../com/amazon/carbonado/repo/map/package-use.html | 117 +++++ 6 files changed, 1016 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-use.html (limited to 'apidocs/com/amazon/carbonado/repo/map') diff --git a/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html new file mode 100644 index 0000000..8191fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html @@ -0,0 +1,481 @@ + + + + + + +MapRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.map
+

Class MapRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class MapRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Volatile repository implementation backed by a concurrent map. Locks used by + repository are coarse, much like table locks. Loads and queries + acquire read locks, and modifications acquire write locks. Within + transactions, loads and queries always acquire upgradable locks, to reduce + the likelihood of deadlock. + +

    This repository supports transactions, which also may be + nested. Supported isolation levels are read committed and serializable. Read + uncommitted is promoted to read committed, and repeatable read is promoted + to serializable. + +

    + The following extra capabilities are supported: +

    + +

    Note: This repository uses concurrent navigable map classes, which became + available in JDK1.6.

    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      intgetLockTimeout() +
      Returns the lock timeout.
      +
      java.util.concurrent.TimeUnitgetLockTimeoutUnit() +
      Returns the lock timeout unit.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      static RepositorynewRepository() +
      Convenience method to build a new MapRepository.
      +
      voidsetLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Set the lock timeout.
      +
      voidsetLockTimeoutMillis(int timeout) +
      Set the lock timeout, in milliseconds.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MapRepositoryBuilder

        +
        public MapRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newRepository

        +
        public static Repository newRepository()
        +
        Convenience method to build a new MapRepository.
        +
        • +
      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setLockTimeoutMillis

        +
        public void setLockTimeoutMillis(int timeout)
        +
        Set the lock timeout, in milliseconds. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        setLockTimeout

        +
        public void setLockTimeout(int timeout,
+                  java.util.concurrent.TimeUnit unit)
        +
        Set the lock timeout. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeout

        +
        public int getLockTimeout()
        +
        Returns the lock timeout. Call getLockTimeoutUnit to get the unit.
        +
        • +
      + + + +
        +
      • +

        getLockTimeoutUnit

        +
        public java.util.concurrent.TimeUnit getLockTimeoutUnit()
        +
        Returns the lock timeout unit. Call getLockTimeout to get the timeout.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html new file mode 100644 index 0000000..029556d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.map.MapRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.map.MapRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.map.MapRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-frame.html b/apidocs/com/amazon/carbonado/repo/map/package-frame.html new file mode 100644 index 0000000..2c3eda2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-frame.html @@ -0,0 +1,20 @@ + + + + + + +com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.map

+
+

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-summary.html b/apidocs/com/amazon/carbonado/repo/map/package-summary.html new file mode 100644 index 0000000..d4d670e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-summary.html @@ -0,0 +1,147 @@ + + + + + + +com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.map

+
+
Volatile repository implementation backed by a concurrent map.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.map Description

+
Volatile repository implementation backed by a concurrent map.
+
See Also:
MapRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-tree.html b/apidocs/com/amazon/carbonado/repo/map/package-tree.html new file mode 100644 index 0000000..994619c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-tree.html @@ -0,0 +1,134 @@ + + + + + + +com.amazon.carbonado.repo.map Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.map

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-use.html b/apidocs/com/amazon/carbonado/repo/map/package-use.html new file mode 100644 index 0000000..a868c87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-use.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.map

+
+
No usage of com.amazon.carbonado.repo.map
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3