org.jsefa.xml.annotation

Annotation Type ListItem

public @interface ListItem

Annotation describing the object type and element name of a list item.

Author:

Norman Lahme-Huetig, Matthias Derer

See Also:

XmlElementList

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the element this annotation describes.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	constraints The constraints to validate.
Class<? extends SimpleTypeConverter>	converterType Specifies the converter type to be used for the xml element which must have a simple data type (no children, no data holding attributes).
String	dataTypeName The name of the data type this ListItem describes.
String[]	format The format to be used to construct a SimpleTypeConverter for the xml element which must have a simple data type (no children, no data holding attributes).
Class<?>	objectType The type of the object this ListItem describes.
TextMode	textMode The text mode.
Class<? extends Validator>	validatorType Specifies the validator type to be used.

Element Detail

name

public abstract String name

The name of the element this annotation describes. It has the following format:
[prefix:]localname

dataTypeName

public abstract String dataTypeName

The name of the data type this ListItem describes. If not set, it must be determinable from the given object type or from the generic parameter argument of the annotated field.

It should be explicitly set if the type mapping should not be created from the annotations given in the class objectType. This is useful when mixing explicit type mapping creation with annotation based type mapping creation.

Default:

""

objectType

public abstract Class<?> objectType

The type of the object this ListItem describes. From this the data type must be determinable if it is not explicity given. If the object type is not set or determinable from the generic parameter argument of the annotated field, the data type name must be given explicitly.

The object type will be ignored if the data type name is given explicitly.

Default:

org.jsefa.common.annotation.NoClass.class

format

public abstract String[] format

The format to be used to construct a SimpleTypeConverter for the xml element which must have a simple data type (no children, no data holding attributes). The SimpleTypeConverter class will be determined using the type of the java field with this annotation.

Default:

{}

textMode

public abstract TextMode textMode

The text mode. Used to define the method for serializing the text content.

Default:

org.jsefa.xml.lowlevel.TextMode.IMPLICIT

converterType

public abstract Class<? extends SimpleTypeConverter> converterType

Specifies the converter type to be used for the xml element which must have a simple data type (no children, no data holding attributes). In the default case the converter type is determined using the type of the list item.

Default:

org.jsefa.common.annotation.NoConverterType.class

validatorType

public abstract Class<? extends Validator> validatorType

Specifies the validator type to be used. In the default case the validator type is determined using the type of the java field with this annotation.

Default:

org.jsefa.common.annotation.NoValidatorType.class

constraints

public abstract String[] constraints

The constraints to validate. Each constraint is a String of the form 'name=value' where name is the name of the constraint and value is its value. The allowed set of constraints depend on the validator type.

Default:

{}