SyntheticProperty (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.synthetic.SyntheticProperty
+

+
+
All Implemented Interfaces:
+
java.lang.Comparable<SyntheticProperty>
+
+
+
+
```
public class SyntheticProperty
+extends java.lang.Object
+implements java.lang.Comparable<SyntheticProperty>
```
+
Minimal specification of a storable property for use with a SyntheticStorableBuilder. + Synthetic storables can be used to generate user storables.
+
Author:
+
Don Schneider, Brian S O'Neill
+

+ +

Constructor Summary

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

Constructors
Constructor and Description
`SyntheticProperty(java.lang.String name, + java.lang.Class type)` + Every property requires minimally a name and a type +
`SyntheticProperty(java.lang.String name, + java.lang.Class type, + boolean isNullable, + boolean isVersion)`

+ +

+ + +

Method Summary

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

Methods
Modifier and Type	Method and Description
`void`	`addAccessorAnnotationDescriptor(java.lang.String annotationDesc)` + Add an arbitrary annotation to the property accessor method, as + specified by a descriptor. +
`int`	`compareTo(SyntheticProperty otherProp)` + `Comparable` implementation. +
`boolean`	`equals(java.lang.Object o)`
`java.util.List<java.lang.String>`	`getAccessorAnnotationDescriptors()` + Returns all the added accessor annotation descriptors in an unmodifiable list. +
`StorablePropertyAdapter`	`getAdapter()`
`java.lang.String`	`getName()`
`java.lang.String`	`getReadMethodName()` + Returns the name of the read method. +
`java.lang.Class`	`getType()`
`java.lang.String`	`getWriteMethodName()` + Returns the name of the write method. +
`int`	`hashCode()`
`boolean`	`isNullable()`
`boolean`	`isVersion()`
`static java.lang.String`	`makeReadMethodName(java.lang.String name, + java.lang.Class type)` + Generate a name for a bean "get" method ("is" method, for booleans). +
`static java.lang.String`	`makeWriteMethodName(java.lang.String name)` + Generate a name for a bean "set" method +
`void`	`setAdapter(StorablePropertyAdapter adapter)` + Storables cannot currently have more than one adapter per property. +
`void`	`setIsNullable(boolean isNullable)`
`void`	`setIsVersion(boolean isVersion)`
`java.lang.String`	`toString()`

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    SyntheticProperty
    +
```
public SyntheticProperty(java.lang.String name,
+                 java.lang.Class type)
```
    +
    Every property requires minimally a name and a type
    +
    Parameters:
    name - for the property
    type - of the data it contains
    +
  + + + +
  - +
    SyntheticProperty
    +
```
public SyntheticProperty(java.lang.String name,
+                 java.lang.Class type,
+                 boolean isNullable,
+                 boolean isVersion)
```
    +
    Parameters:
    name - property name
    type - property type
    isNullable - true if this property can be null (default false)
    isVersion - true if this property is a version number (default false)
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    makeReadMethodName
    +
```
public static java.lang.String makeReadMethodName(java.lang.String name,
+                                  java.lang.Class type)
```
    +
    Generate a name for a bean "get" method ("is" method, for booleans).
    +
    Parameters:
    name - of the property
    type - return type of the property
    See Also:
    getReadMethodName()
    +
  + + + +
  - +
    makeWriteMethodName
    +
```
public static java.lang.String makeWriteMethodName(java.lang.String name)
```
    +
    Generate a name for a bean "set" method
    +
    Parameters:
    name - of the property
    See Also:
    getWriteMethodName()
    +
  + + + +
  - +
    getName
    +
```
public java.lang.String getName()
```
    +
    Returns:
    Name of the property
    +
  + + + +
  - +
    getType
    +
```
public java.lang.Class getType()
```
    +
    Returns:
    type of the property
    +
  + + + +
  - +
    isNullable
    +
```
public boolean isNullable()
```
    +
    Returns:
    true if the property can be null
    +
  + + + +
  - +
    setIsNullable
    +
```
public void setIsNullable(boolean isNullable)
```
    +
    Parameters:
    isNullable - true if the property can be null
    +
  + + + +
  - +
    isVersion
    +
```
public boolean isVersion()
```
    +
    Returns:
    true if the property contains the versioning information for the storable. Note that + at most one property can be the version property for a given storable
    +
  + + + +
  - +
    setIsVersion
    +
```
public void setIsVersion(boolean isVersion)
```
    +
    Parameters:
    isVersion - true if the property should contain the versioning information for the + storable
    +
  + + + +
  - +
    getReadMethodName
    +
```
public java.lang.String getReadMethodName()
```
    +
    Returns the name of the read method.
    +
  + + + +
  - +
    getWriteMethodName
    +
```
public java.lang.String getWriteMethodName()
```
    +
    Returns the name of the write method.
    +
  + + + +
  - +
    getAdapter
    +
```
public StorablePropertyAdapter getAdapter()
```
    +
    Returns:
    the optional adapter.
    +
  + + + +
  - +
    setAdapter
    +
```
public void setAdapter(StorablePropertyAdapter adapter)
```
    +
    Storables cannot currently have more than one adapter per property.
    +
    Parameters:
    adapter - The adapter to set.
    +
  + + + +
  - +
    addAccessorAnnotationDescriptor
    +
```
public void addAccessorAnnotationDescriptor(java.lang.String annotationDesc)
```
    +
    Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.
    +
    See Also:
    AnnotationDescPrinter
    +
  + + + +
  - +
    getAccessorAnnotationDescriptors
    +
```
public java.util.List<java.lang.String> getAccessorAnnotationDescriptors()
```
    +
    Returns all the added accessor annotation descriptors in an unmodifiable list.
    +
  + + + +
  - +
    compareTo
    +
```
public int compareTo(SyntheticProperty otherProp)
```
    +
    Comparable implementation.
    +
    +
    Specified by:
    +
    compareTo in interface java.lang.Comparable<SyntheticProperty>
    +
    Parameters:
    otherProp -
    +
  + + + +
  - +
    equals
    +
```
public boolean equals(java.lang.Object o)
```
    +
    +
    Overrides:
    +
    equals in class java.lang.Object
    +
    +
  + + + +
  - +
    hashCode
    +
```
public int hashCode()
```
    +
    +
    Overrides:
    +
    hashCode in class java.lang.Object
    +
    +
  + + + +
  - +
    toString
    +
```
public java.lang.String toString()
```
    +
    +
    Overrides:
    +
    toString in class java.lang.Object
    +
    +
  +
+

Class SyntheticProperty

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SyntheticProperty

SyntheticProperty

Method Detail

makeReadMethodName

makeWriteMethodName

getName

getType

isNullable

setIsNullable

isVersion

setIsVersion

getReadMethodName

getWriteMethodName

getAdapter

setAdapter

addAccessorAnnotationDescriptor

getAccessorAnnotationDescriptors

compareTo

equals

hashCode

toString