Package io.kaitai.struct.annotations

Annotation Type SeqItem

@Documented
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public @interface SeqItem

Annotation, that applied to fields, getters or setters that represents an attribute from seq KSY element.

Since:

0.9

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	doc	Documentation string attached to the attribute, specified in doc KSY element.
String	id	Original identifier (id key) from ksy file.
int	index	Index of an attribute in sequence of attributes in the type.

Element Detail

id

String id

Original identifier (id key) from ksy file.

Returns:

Identifier, that can differ from field name, if it clash with Java reserved words. Empty string, if attribute was unnamed

index

int index

Index of an attribute in sequence of attributes in the type.

Returns:

0-based index of an attribute in seq KSY element

doc

String doc

Documentation string attached to the attribute, specified in doc KSY element.

Returns:

Documentation string for and attribute. If documentation is missed, returns empty string