Package io.kaitai.struct.annotations

Annotation Type Parameter

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

Annotation, that applied to fields, getters or setters that represents parameter from params KSY element.

Since:

0.9

Required Element Summary

Required Elements

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

Element Detail

id

String id

Original identifier (id key) from ksy file.

Returns:

Identifier, that can differ from parameter name, if it clash with Java reserved words. Can not be empty

index

int index

Index of a parameter in sequence of parameters in the type.

Returns:

0-based index of a parameter in params KSY element

doc

String doc

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

Returns:

Documentation string for parameter. If documentation is missed, returns empty string