com.sappenin.objectify.annotation

Annotation Type Money

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Money

When placed on an entity field of type Money or BigMoney, the following properties will be stored for that property:

• The currency value, encoded as a lexigraphically-encoded String.
• The currency code, as a String
• (Optional) Currency value in human-readable format (enabled by default)

To customize the behavior of this annotation, the following properties may be set:

• storeDisplayableAmount: Set to true to store a displayable currency amount for human-readability in the App Engine Datastore Viewer (defaults to true).


• indexDisplayableAmount: Set to to index the displayableAmount property (defaults to false).
  Note that this value will not index properly, so this should generally not be used.


• displayableAmountFieldName: The property-name to store the displayableAmount in Appengine Datastore Entities. (defaults to 'displayableAmount').


• encodedAmountFieldName: The property-name to store the encodedAmount value in Appengine Datastore Entities. (defaults to 'encodedAmount').


• indexEncodedAmount: Set to true to index the encodedAmount property (defaults to true).


• indexCurrencyCode: Set to true to index the currencyCode property (defaults to false).


• currencyCodeFieldName: The property-name to store the currencyCode value in Appengine Datastore Entities. (defaults to 'currencyCode').

Author:

David Fuelling

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	currencyCodeFieldName
String	displayableAmountFieldName
String	encodedAmountFieldName
boolean	indexCurrencyCode
boolean	indexDisplayableAmount
boolean	indexEncodedAmount
boolean	storeDisplayableAmount

Element Detail

storeDisplayableAmount

public abstract boolean storeDisplayableAmount

Default:

true

indexDisplayableAmount

public abstract boolean indexDisplayableAmount

Default:

false

displayableAmountFieldName

public abstract String displayableAmountFieldName

Default:

"displayableAmount"

encodedAmountFieldName

public abstract String encodedAmountFieldName

Default:

"encodedAmount"

indexEncodedAmount

public abstract boolean indexEncodedAmount

Default:

true

currencyCodeFieldName

public abstract String currencyCodeFieldName

Default:

"currencyCode"

indexCurrencyCode

public abstract boolean indexCurrencyCode

Default:

false