io.permazen.annotation

Annotation Type JMapField

@Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,METHOD})
 @Documented
public @interface JMapField

Java annotation for the getter methods of Java bean properties reflecting Permazen Map fields.

The annotated method's return type must be either Map<K, V>, SortedMap<K, V>, or NavigableMap<K, V>, where K and V are supported simple types.

Note that both primitive types and their corresponding wrapper types are supported as keys and/or values. A map whose keys/values have primitive type will throw an exception on an attempt to add a null key/value. To specify a primitive key or value type, specify the type name (e.g., "int") as the JField.type() in the key() or the value().

Meta-Annotations

This annotation may be configured indirectly as a Spring meta-annotation when spring-core is on the classpath.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
JField	key Storage ID and index setting for the field's keys.
String	name The name of this field.
int	storageId Storage ID for this field.
JField	value Storage ID and index setting for the field's values.

Element Detail

name

public abstract String name

The name of this field.

If empty string (default value), the name is inferred from the name of the annotated Java bean getter method.

Returns:

the map field name

Default:

""

storageId

public abstract int storageId

Storage ID for this field. Value should be positive and unique within the contained class. If zero, the configured StorageIdGenerator will be consulted to auto-generate a value.

Returns:

the map field storage ID

See Also:

StorageIdGenerator.generateFieldStorageId()

Default:

0

key

public abstract JField key

Storage ID and index setting for the field's keys. Note: the name property must be left unset.

Returns:

the map key field

Default:

@io.permazen.annotation.JField

value

public abstract JField value

Storage ID and index setting for the field's values. Note: the name property must be left unset.

Returns:

the map value field

Default:

@io.permazen.annotation.JField