Package io.kaitai.struct.annotations

Annotation Type Instance

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

Annotation, that applied to fields, getters or setters that represents instance field from instances KSY element.

Since:

0.9

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	doc	Documentation string attached to the instance definition, specified in doc KSY element.
String	id	Original identifier (id key) from ksy file.

Element Detail

id

String id

Original identifier (id key) from ksy file.

Returns:

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

doc

String doc

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

Returns:

Documentation string for an instance. If documentation is missed, returns empty string