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 --- .../replicated/ReplicatedRepositoryBuilder.html | 473 +++++++++++++++++++++ 1 file changed, 473 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html (limited to 'apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html') diff --git a/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..15c406c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html @@ -0,0 +1,473 @@ + + + + + + +ReplicatedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.replicated
+

Class ReplicatedRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class ReplicatedRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Repository builder for the replicated repository. +

    + The following extra capabilities are supported: +

    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplicatedRepositoryBuilder

        +
        public ReplicatedRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        getReplicaRepositoryBuilder

        +
        public RepositoryBuilder getReplicaRepositoryBuilder()
        +
        Returns:
        "replica" respository to replicate to.
        +
        • +
      + + + +
        +
      • +

        setReplicaRepositoryBuilder

        +
        public void setReplicaRepositoryBuilder(RepositoryBuilder replicaRepositoryBuilder)
        +
        Set "replica" respository to replicate to, which is required. This builder + automatically sets the master option of the given repository builder to + false.
        +
        • +
      + + + +
        +
      • +

        getMasterRepositoryBuilder

        +
        public RepositoryBuilder getMasterRepositoryBuilder()
        +
        Returns:
        "master" respository to replicate from.
        +
        • +
      + + + +
        +
      • +

        setMasterRepositoryBuilder

        +
        public void setMasterRepositoryBuilder(RepositoryBuilder masterRepositoryBuilder)
        +
        Set "master" respository to replicate from, which is required. This + builder automatically sets the master option of the given repository to + true.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3