org.jsefa.xml.annotation

Annotation Type XmlElement

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

An annotation stating that the annotated java field should be mapped to a xml element during XML serialization and deserialization.

Author:

Norman Lahme-Huetig, Matthias Derer

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 of the element this annotation describes.
DefaultName	defaultName The type of default name if no explicit name is given.
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).
SimpleListItem	listItem In case of a simple type list this annotation parameter provides details about the list items.
String	name The name of the element this annotation describes.
int	pos The position of the xml element with the following semantic:
boolean	required True, if a value is required; false otherwise.
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

Default:

""

defaultName

public abstract DefaultName defaultName

The type of default name if no explicit name is given.

Default:

org.jsefa.xml.annotation.DefaultName.FIELD_NAME

dataTypeName

public abstract String dataTypeName

The name of the data type of the element this annotation describes. If not set, it must be determinable from the type of the annotated field.

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

Default:

""

pos

public abstract int pos

The position of the xml element with the following semantic:

If the position of a element A is less than the position of a element B, than element A comes (not necessarily directly) before element B.
All elements with the default position value (-1) will come after all elements with explicitly given positions.

Default:

-1

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

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:

{}

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 java field with this annotation.

Default:

org.jsefa.common.annotation.NoConverterType.class

listItem

public abstract SimpleListItem listItem

In case of a simple type list this annotation parameter provides details about the list items.

Default:

@org.jsefa.common.annotation.SimpleListItem

required

public abstract boolean required

True, if a value is required; false otherwise.

Default:

false

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:

{}