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 --- apidocs/index-files/index-2.html | 415 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 415 insertions(+) create mode 100644 apidocs/index-files/index-2.html (limited to 'apidocs/index-files/index-2.html') diff --git a/apidocs/index-files/index-2.html b/apidocs/index-files/index-2.html new file mode 100644 index 0000000..8c980bc --- /dev/null +++ b/apidocs/index-files/index-2.html @@ -0,0 +1,415 @@ + + + + + + +B-Index (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
A B C D E F G H I J K L M N O P Q R S T U V W Y  + + +

B

+
+
backoff(E, int, int) - Static method in exception com.amazon.carbonado.RepositoryException
+
+
One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time.
+
+
BDBPanicHandler - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Interface for a generic panic handler for any BDB products.
+
+
BDBProduct - Enum in com.amazon.carbonado.repo.sleepycat
+
+
Set of supported BDB products.
+
+
BDBRepositoryBuilder - Class in com.amazon.carbonado.repo.sleepycat
+
+
Builder and configuration options for BDBRepository.
+
+
BDBRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
BDBRepositoryBuilder.DatabaseHook - Interface in com.amazon.carbonado.repo.sleepycat
+
 
+
beforeDelete(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a bogus storable is to be deleted.
+
+
beforeDelete(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeDelete(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeDelete(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted.
+
+
beforeDelete(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted.
+
+
beforeInsert(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a sync'd storable is to be inserted.
+
+
beforeInsert(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeInsert(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeInsert(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted.
+
+
beforeInsert(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted.
+
+
beforeTryDelete(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryDelete(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryDelete(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted via tryDelete.
+
+
beforeTryDelete(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted via tryDelete.
+
+
beforeTryInsert(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryInsert(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryInsert(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted via tryInsert.
+
+
beforeTryInsert(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted via tryInsert.
+
+
beforeTryUpdate(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryUpdate(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryUpdate(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated via tryUpdate.
+
+
beforeTryUpdate(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated via tryUpdate.
+
+
beforeUpdate(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a sync'd storable is to be updated.
+
+
beforeUpdate(S, S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.
+
+
beforeUpdate(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeUpdate(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeUpdate(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated.
+
+
beforeUpdate(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated.
+
+
begin() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Called by query when it begins, possibly multiple times.
+
+
begin() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
beginCall(RemoteProcedure<R, D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedureCapability
+
+
Begins a call to execute the given procedure on a remote host.
+
+
beginGroup(S) - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
This method is called for the first entry in a group.
+
+
beginReply() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Begin a reply after receiving all data.
+
+
BelatedCreationException - Exception in com.amazon.carbonado.util
+
+
Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.
+
+
BelatedCreationException(String) - Constructor for exception com.amazon.carbonado.util.BelatedCreationException
+
+
Create a new exception with the given message.
+
+
BelatedCreationException(String, Throwable) - Constructor for exception com.amazon.carbonado.util.BelatedCreationException
+
+
Create a new exception with the given message and cause.
+
+
BelatedCreator<T,E extends java.lang.Exception> - Class in com.amazon.carbonado.util
+
+
Generic one-shot factory which supports late object creation.
+
+
BelatedCreator(Class<T>, int) - Constructor for class com.amazon.carbonado.util.BelatedCreator
+
 
+
BelatedRepositoryCreator - Class in com.amazon.carbonado.spi
+
+
Generic one-shot Repository builder which supports late object creation.
+
+
BelatedRepositoryCreator(Log, RepositoryBuilder, int) - Constructor for class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
BelatedRepositoryCreator(Log, RepositoryBuilder, AtomicReference<Repository>, int) - Constructor for class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
BelatedStorageCreator<S extends Storable> - Class in com.amazon.carbonado.spi
+
+
Generic one-shot Storage creator which supports late object creation.
+
+
BelatedStorageCreator(Log, Repository, Class<S>, int) - Constructor for class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
BinaryOpFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Base class for filter tree nodes that have a left and right child.
+
+
bind() - Method in class com.amazon.carbonado.filter.BinaryOpFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.Filter
+
+
Walks through each property filter, assigning a bind ID to it.
+
+
bind() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
bindQueryParam(Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Determines which overloaded "with" method on Query should be bound to.
+
+
blankValue(CodeBuilder, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to push a blank value to the stack.
+
+
Blob - Interface in com.amazon.carbonado.lob
+
+
Provides access to BLOBs, which are Binary Large OBjects.
+
+
BlobClob - Class in com.amazon.carbonado.lob
+
+
A Clob implementation which is backed by a Blob.
+
+
BlobClob(Blob) - Constructor for class com.amazon.carbonado.lob.BlobClob
+
 
+
BoundaryType - Enum in com.amazon.carbonado.qe
+
+
Describes a value range boundary.
+
+
build(RepositoryAccess, ChainedProperty<T>, Filter<T>, OrderingList<T>, QueryHints) - Static method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
+
Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.
+
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
build() - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Builds a repository instance.
+
+
build(AtomicReference<Repository>) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Builds a repository instance.
+
+
build() - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
build() - Method in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
+
Defines the class for this generator
+
+
build() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Convenience method to generate the class.
+
+
build() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
build() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
build(Class<C>) - Static method in class com.amazon.carbonado.util.Converter
+
 
+
buildClass(Class<C>) - Static method in class com.amazon.carbonado.util.Converter
+
 
+
buildDataDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int, Label, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties.
+
+
buildDataEncoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties.
+
+
buildKeyDecoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties.
+
+
buildKeyEncoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties.
+
+
buildPkIndex(String...) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Convenient way to define the clustered primary key index + descriptor.
+
+
buildRootAnnotation(TypeDesc) - Method in class com.amazon.carbonado.util.AnnotationDescParser
+
+
Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type.
+
+
buildSerialDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties and their states.
+
+
buildSerialEncoding(CodeAssembler, StorableProperty<S>[]) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties and their + states.
+
+
ByteArrayBlob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Blob which is backed by a growable in-memory byte array.
+
+
ByteArrayBlob(int) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob with the given initial capacity.
+
+
ByteArrayBlob(byte[]) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob initially backed by the given byte array.
+
+
ByteArrayBlob(byte[], int) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob initially backed by the given byte array.
+
+
+A B C D E F G H I J K L M N O P Q R S T U V W Y 
+ +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3