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

Class AbstractRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanaddTriggerFactory(TriggerFactory factory) +
      Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.
      +
      voidassertReady() +
      Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.
      +
      Repositorybuild() +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      java.lang.Iterable<TriggerFactory>getTriggerFactories() +
      Returns all the TriggerFactories which were added.
      +
      booleanremoveTriggerFactory(TriggerFactory factory) +
      Remove a TriggerFactory which was added earlier.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractRepositoryBuilder

        +
        protected AbstractRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        addTriggerFactory

        +
        public boolean addTriggerFactory(TriggerFactory factory)
        +
        Description copied from interface: RepositoryBuilder
        +
        Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.
        +
        +
        Specified by:
        +
        addTriggerFactory in interface RepositoryBuilder
        +
        Returns:
        true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered
        +
        • +
      + + + +
        +
      • +

        removeTriggerFactory

        +
        public boolean removeTriggerFactory(TriggerFactory factory)
        +
        Description copied from interface: RepositoryBuilder
        +
        Remove a TriggerFactory which was added earlier.
        +
        +
        Specified by:
        +
        removeTriggerFactory in interface RepositoryBuilder
        +
        Returns:
        true if TriggerFactory instance was removed, false if not added
        +
        • +
      + + + + + + + +
        +
      • +

        assertReady

        +
        public final void assertReady()
+                       throws ConfigurationException
        +
        Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.
        +
        Throws:
        +
        ConfigurationException
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        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