org.jsefa.xml.annotation

Annotation Type XmlAttribute

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

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

Author:

Norman Lahme-Huetig

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 attribute.
String	dataTypeName The name of the data type of the attribute this annotation describes.
String[]	format The format to be used to construct a SimpleTypeConverter for the xml attribute.
SimpleListItem	listItem In case of a simple type list this annotation parameter provides details about the list items.
String	name The name of the xml attribute this annotation describes.
boolean	required True, if a value is required; false otherwise.
Class<? extends Validator>	validatorType Specifies the validator type to be used.

Element Detail

name

public abstract String name

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

Default:

""

dataTypeName

public abstract String dataTypeName

The name of the data type of the attribute 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:

""

format

public abstract String[] format

The format to be used to construct a SimpleTypeConverter for the xml attribute. 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 attribute. 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:

{}