com.googlecode.mjorm.annotations

Annotation Type Property

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Property

Marks a method as a property that will be mapped to a field on a document. All of this annotations parameters are optional. This annotation must be used on property getter methods, methods that start with "is" or "get".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	field Optionally specifies the name of the field on the MongoDB document that the property annotated by this will use.
java.lang.Class<?>[]	genericParameterTypes Optionally specifies the type parameters for any generic type parameters specified by type() (or the type that is inferred).
java.lang.Class<?>	storageType Optionally specifies the type that should be used to store this property.
java.lang.Class<?>	type Optionally specifies the type that should be used for this property.
TypeConversionHint[]	typeConversionHints Optionally specifies conversion hints that are used by the ObjectMapper when conversion this property to and from the MongoDB document's field.
java.lang.Class<?>	valueGeneratorClass The class that generates values for the property.

Element Detail

field

public abstract java.lang.String field

Optionally specifies the name of the field on the MongoDB document that the property annotated by this will use. By default it will take on the annotated property's name.

Returns:

Default:

""

type

public abstract java.lang.Class<?> type

Optionally specifies the type that should be used for this property. By default the method's return type is used.

Returns:

Default:

void.class

storageType

public abstract java.lang.Class<?> storageType

Optionally specifies the type that should be used to store this property. By default the method's return type is used.

Returns:

Default:

void.class

genericParameterTypes

public abstract java.lang.Class<?>[] genericParameterTypes

Optionally specifies the type parameters for any generic type parameters specified by type() (or the type that is inferred).

Returns:

Default:

{}

valueGeneratorClass

public abstract java.lang.Class<?> valueGeneratorClass

The class that generates values for the property.

Returns:

the value generator

Default:

void.class

typeConversionHints

public abstract TypeConversionHint[] typeConversionHints

Optionally specifies conversion hints that are used by the ObjectMapper when conversion this property to and from the MongoDB document's field.

Returns:

Default:

{}