Segment (2.1.0 2.1.0 API)

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

Segment annotation applied to class members or methods.

Since:: 2.1.0

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`int`	`at` The absolute position of the segment.
`Class<?>`	`collection` The collection class bound to this segment, if one cannot be derived from the annotated field or method.
`String`	`getter` The getter method.
`String`	`key` The name of a child component to use for the key value if this segment is bound to a `Map`.
`boolean`	`lazy` Whether the class bound to this segment should be instantiated if all child fields are null or empty strings.
`int`	`maxOccurs` The maximum occurrences.
`int`	`minOccurs` The minimum occurrences.
`String`	`name` The segment name.
`boolean`	`nillable` Whether the element is nillable.
`String`	`occursRef` The name of a preceding field that governs the number of occurrences of this segment.
`int`	`ordinal` The relative position of the segment.
`String`	`setter` The setter method.
`Class<?>`	`type` The class bound to this segment, if one cannot be derived from the annotated field or method.
`int`	`until` The maximum position of a segment that repeats for an indeterminate number of times.
`String`	`value` The name of a child component to use for the value of this segment in lieu of a type.
`String`	`xmlName` The XML attribute or element name.
`String`	`xmlNamespace` The XML namespace URI of this segment.
`String`	`xmlPrefix` The XML namespace prefix of this segment.
`XmlType`	`xmlType` The XML type of this segment.

- Element Detail
  - name
```
public abstract String name
```
    The segment name.
    
    Returns:
    
    the segment name
    
    Default:
    
    ""
- - at
```
public abstract int at
```
    The absolute position of the segment.
    
    Returns:
    
    the absolute position
    
    Default:
    
    -2147483648
- - until
```
public abstract int until
```
    The maximum position of a segment that repeats for an indeterminate number of times.
    
    Returns:
    
    the maximum position
    
    Default:
    
    -2147483648
- - ordinal
```
public abstract int ordinal
```
    The relative position of the segment.
    
    Returns:
    
    the relative position
    
    Default:
    
    -2147483648
- - getter
```
public abstract String getter
```
    The getter method.
    
    Returns:
    
    the getter method name
    
    Default:
    
    ""
- - setter
```
public abstract String setter
```
    The setter method.
    
    Returns:
    
    the setter method name
    
    Default:
    
    ""
- - type
```
public abstract Class<?> type
```
    The class bound to this segment, if one cannot be derived from the annotated field or method.
    
    Returns:
    
    the class
    
    Default:
    
    java.lang.Void.class
- - lazy
```
public abstract boolean lazy
```
    Whether the class bound to this segment should be instantiated if all child fields are null or empty strings. Also causes empty collections to returned as null.
    
    Returns:
    
    whether the segment is lazily created
    
    Default:
    
    false
- - collection
```
public abstract Class<?> collection
```
    The collection class bound to this segment, if one cannot be derived from the annotated field or method.
    
    Returns:
    
    the collection class
    
    Default:
    
    java.lang.Void.class
- - minOccurs
```
public abstract int minOccurs
```
    The minimum occurrences.
    
    Returns:
    
    the minimum occurrences
    
    Default:
    
    -2147483648
- - maxOccurs
```
public abstract int maxOccurs
```
    The maximum occurrences.
    
    Returns:
    
    the maximum occurrences, or -1 if unbounded
    
    Default:
    
    -2147483648
- - occursRef
```
public abstract String occursRef
```
    The name of a preceding field that governs the number of occurrences of this segment. Does not apply to XML formatted streams.
    
    Returns:
    
    the name of the field
    
    Default:
    
    ""
- - key
```
public abstract String key
```
    The name of a child component to use for the key value if this segment is bound to a Map.
    
    Returns:
    
    the component name of the key
    
    Default:
    
    ""
- - value
```
public abstract String value
```
    The name of a child component to use for the value of this segment in lieu of a type.
    
    Returns:
    
    the component name of the value
    
    Default:
    
    ""
- - xmlType
```
public abstract XmlType xmlType
```
    The XML type of this segment.
    
    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 segment.
    
    Returns:
    
    the namespace prefix
    
    Default:
    
    "{undefined}"
- - xmlNamespace
```
public abstract String xmlNamespace
```
    The XML namespace URI of this segment.
    
    Returns:
    
    the namespace URI
    
    Default:
    
    "{undefined}"
- - nillable
```
public abstract boolean nillable
```
    Whether the element is nillable.
    
    Returns:
    
    true if nillable, false otherwise
    
    Default:
    
    false

Annotation Type Segment

Optional Element Summary

Element Detail

name

at

until

ordinal

getter

setter

type

lazy

collection

minOccurs

maxOccurs

occursRef

key

value

xmlType

xmlName

xmlPrefix

xmlNamespace

nillable