org.beanio.annotation

Annotation Type Group

@Retention(value=RUNTIME)
 @Target(value={TYPE,FIELD,METHOD})
public @interface Group

Group annotation for classes, and for fields and methods in a class annotated by a parent Group.

Since:

2.1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	collection The collection type for repeating group bound to a parent group class, if it cannot be determined from the annotated field or method declaration.
String	getter The getter method on its parent group class.
int	maxOccurs The maximum occurrences of the record.
int	minOccurs The minimum occurrences of the record
String	name The group name.
int	order The order of this record within its parent group.
String	setter The setter method on its parent group class.
Class<?>	type The group type, if it cannot be determined from the annotated field or method declaration.
String	value The name of child component to use for the value of this record in lieu of a type.
String	xmlName The XML attribute or element name.
String	xmlNamespace The XML namespace URI of this record.
String	xmlPrefix The XML namespace prefix of this record.
XmlType	xmlType The XML type of this record.

Element Detail

name

public abstract String name

The group name.

Returns:

the record name

Default:

""

getter

public abstract String getter

The getter method on its parent group class.

Returns:

the method name

Default:

""

setter

public abstract String setter

The setter method on its parent group class.

Returns:

the method name

Default:

""

type

public abstract Class<?> type

The group type, if it cannot be determined from the annotated field or method declaration.

Returns:

the class type

Default:

java.lang.Void.class

collection

public abstract Class<?> collection

The collection type for repeating group bound to a parent group class, if it cannot be determined from the annotated field or method declaration.

Returns:

the collection type

Default:

java.lang.Void.class

minOccurs

public abstract int minOccurs

The minimum occurrences of the record

Returns:

the minimum occurrences

Default:

-2147483648

maxOccurs

public abstract int maxOccurs

The maximum occurrences of the record.

Returns:

the maximum occurrences

Default:

-2147483648

order

public abstract int order

The order of this record within its parent group.

Returns:

the order

Default:

-2147483648

value

public abstract String value

The name of child component to use for the value of this record in lieu of a type.

Returns:

the component name of the value

Default:

""

xmlType

public abstract XmlType xmlType

The XML type of this record.

Returns:

the XmlType

Default:

org.beanio.builder.XmlType.DEFAULT

xmlName

public abstract String xmlName

The XML attribute or element name.

Returns:

the XML name

Default:

"{undefined}"

xmlPrefix

public abstract String xmlPrefix

The XML namespace prefix of this record.

Returns:

the namespace prefix

Default:

"{undefined}"

xmlNamespace

public abstract String xmlNamespace

The XML namespace URI of this record.

Returns:

the namespace URI

Default:

"{undefined}"