Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder (Carbonado 1.2.3 API)

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 --- .../synthetic/class-use/ClassFileBuilder.html | 168 ++++++++++++++ .../SyntheticBuilder.ClassNameProvider.html | 173 ++++++++++++++ .../synthetic/class-use/SyntheticBuilder.html | 169 ++++++++++++++ .../synthetic/class-use/SyntheticIndex.html | 170 ++++++++++++++ .../synthetic/class-use/SyntheticKey.html | 184 +++++++++++++++ .../synthetic/class-use/SyntheticProperty.html | 251 +++++++++++++++++++++ .../synthetic/class-use/SyntheticPropertyList.html | 168 ++++++++++++++ .../class-use/SyntheticStorableBuilder.html | 117 ++++++++++ .../SyntheticStorableReferenceAccess.html | 162 +++++++++++++ .../SyntheticStorableReferenceBuilder.html | 117 ++++++++++ 10 files changed, 1679 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html (limited to 'apidocs/com/amazon/carbonado/synthetic/class-use') diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html new file mode 100644 index 0000000..8336989 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html @@ -0,0 +1,168 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use ClassFileBuilder
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of ClassFileBuilder in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return ClassFileBuilder
Modifier and Type	Method and Description
`ClassFileBuilder`	SyntheticStorableReferenceBuilder.`prepare()`
`ClassFileBuilder`	SyntheticStorableBuilder.`prepare()`
`ClassFileBuilder`	SyntheticBuilder.`prepare()`

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html new file mode 100644 index 0000000..ed6d885 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html @@ -0,0 +1,173 @@ + + + + + + +Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use SyntheticBuilder.ClassNameProvider
Package	Description
com.amazon.carbonado.synthetic	+ Support for dynamic creation of storables, intended for internal use by + repository implementations. +

+ + +

Uses of SyntheticBuilder.ClassNameProvider in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return SyntheticBuilder.ClassNameProvider
Modifier and Type	Method and Description
`SyntheticBuilder.ClassNameProvider`	SyntheticStorableBuilder.`getClassNameProvider()`

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

Methods in com.amazon.carbonado.synthetic with parameters of type SyntheticBuilder.ClassNameProvider
Modifier and Type	Method and Description
`void`	SyntheticStorableBuilder.`setClassNameProvider(SyntheticBuilder.ClassNameProvider classNameProvider)`

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html new file mode 100644 index 0000000..718e671 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html @@ -0,0 +1,169 @@ + + + + + + +Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use SyntheticBuilder
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of SyntheticBuilder in com.amazon.carbonado.synthetic

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

Classes in com.amazon.carbonado.synthetic that implement SyntheticBuilder
Modifier and Type	Class and Description
`class`	`SyntheticStorableBuilder` + Allows the definition of very simple synthetic storables. +
`class`	`SyntheticStorableReferenceBuilder<S extends Storable>` + A SyntheticStorableReference defines new kinds of Storables from an existing + master storable. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html new file mode 100644 index 0000000..d7d38a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticIndex (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use SyntheticIndex
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of SyntheticIndex in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return SyntheticIndex
Modifier and Type	Method and Description
`SyntheticIndex`	SyntheticStorableReferenceBuilder.`addIndex()`
`SyntheticIndex`	SyntheticStorableBuilder.`addIndex()`
`SyntheticIndex`	SyntheticBuilder.`addIndex()` + Add an index to the set managed by this builder. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html new file mode 100644 index 0000000..c8a9bbd --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html @@ -0,0 +1,184 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticKey (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use SyntheticKey
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of SyntheticKey in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return SyntheticKey
Modifier and Type	Method and Description
`SyntheticKey`	SyntheticStorableReferenceBuilder.`addAlternateKey()`
`SyntheticKey`	SyntheticStorableBuilder.`addAlternateKey()`
`SyntheticKey`	SyntheticBuilder.`addAlternateKey()` + Add an alternate key to be built. +
`SyntheticKey`	SyntheticStorableReferenceBuilder.`addPrimaryKey()`
`SyntheticKey`	SyntheticStorableBuilder.`addPrimaryKey()`
`SyntheticKey`	SyntheticBuilder.`addPrimaryKey()` + Add a primary key to be built. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html new file mode 100644 index 0000000..502d77f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html @@ -0,0 +1,251 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticProperty (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use SyntheticProperty
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of SyntheticProperty in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return SyntheticProperty
Modifier and Type	Method and Description
`SyntheticProperty`	SyntheticStorableReferenceBuilder.`addKeyProperty(java.lang.String name, + Direction direction)` + Add a property to the primary key which is a member of the Storable type + being referenced by this one. +
`SyntheticProperty`	SyntheticStorableReferenceBuilder.`addProperty(java.lang.String name, + java.lang.Class type)`
`SyntheticProperty`	SyntheticStorableBuilder.`addProperty(java.lang.String name, + java.lang.Class type)`
`SyntheticProperty`	SyntheticBuilder.`addProperty(java.lang.String name, + java.lang.Class type)` + Add a property to the set managed by this builder. +
`SyntheticProperty`	SyntheticStorableReferenceBuilder.`addProperty(SyntheticProperty prop)`
`SyntheticProperty`	SyntheticStorableBuilder.`addProperty(SyntheticProperty prop)`
`SyntheticProperty`	SyntheticBuilder.`addProperty(SyntheticProperty prop)` + Add an externally defined synthetic property to the list +

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

Methods in com.amazon.carbonado.synthetic that return types with arguments of type SyntheticProperty
Modifier and Type	Method and Description
`protected java.util.List<SyntheticProperty>`	SyntheticStorableBuilder.`getPropertyList()` + Frequently used by the `SyntheticBuilder.ClassNameProvider` as a + basis for the generated classname +
`java.util.List<SyntheticProperty>`	SyntheticStorableReferenceBuilder.`getUserProps()`

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

Methods in com.amazon.carbonado.synthetic with parameters of type SyntheticProperty
Modifier and Type	Method and Description
`SyntheticProperty`	SyntheticStorableReferenceBuilder.`addProperty(SyntheticProperty prop)`
`SyntheticProperty`	SyntheticStorableBuilder.`addProperty(SyntheticProperty prop)`
`SyntheticProperty`	SyntheticBuilder.`addProperty(SyntheticProperty prop)` + Add an externally defined synthetic property to the list +
`int`	SyntheticProperty.`compareTo(SyntheticProperty otherProp)` + `Comparable` implementation. +
`protected boolean`	SyntheticStorableBuilder.`definePropertyBeanMethods(org.cojen.classfile.ClassFile cf, + SyntheticProperty property)` + Add the get & set methods for this property +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html new file mode 100644 index 0000000..bb6edb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html @@ -0,0 +1,168 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticPropertyList (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use SyntheticPropertyList
Package Description
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

+ + +

Uses of SyntheticPropertyList in com.amazon.carbonado.synthetic

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

Subclasses of SyntheticPropertyList in com.amazon.carbonado.synthetic
Modifier and Type	Class and Description
`class`	`SyntheticIndex` + Specification of a collection of properties which will participate in an index. +
`class`	`SyntheticKey` + Specification of a collection of properties which will participate in a key. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.synthetic.SyntheticStorableBuilder

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..1a5915e --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use SyntheticStorableReferenceAccess
Package	Description
com.amazon.carbonado.synthetic	+ Support for dynamic creation of storables, intended for internal use by + repository implementations. +

+ + +

Uses of SyntheticStorableReferenceAccess in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return SyntheticStorableReferenceAccess
Modifier and Type	Method and Description
`SyntheticStorableReferenceAccess<S>`	SyntheticStorableReferenceBuilder.`getReferenceAccess()` + Build and return access to the generated storable reference class. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +