dk.vajhoej.record

Annotation Type StructField

@Retention(value=RUNTIME)
public @interface StructField

Annotation for fields.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	n Field number.
FieldType	type Field type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	decimals Field decimals (for BCD's).
java.lang.String	encoding Field encoding (for strings).
ExtEndian	endianess Byte order.
int	length Field length (for fixed length strings and BCD's).
boolean	pad Pad to length (for fixed length strings).
char	padchar Pad character (for fixed length strings with pad=true).
int	prefixlength Prefix length (for variable length strings).
byte	zone Field zone value (for zoned BCD's).

Element Detail

n

public abstract int n

Field number.

Returns:

number starting at zero

type

public abstract FieldType type

Field type.

Returns:

type

length

public abstract int length

Field length (for fixed length strings and BCD's).

Returns:

length

Default:

0

decimals

public abstract int decimals

Field decimals (for BCD's).

Returns:

decimals

Default:

0

encoding

public abstract java.lang.String encoding

Field encoding (for strings).

Returns:

encoding name

Default:

"ISO-8859-1"

zone

public abstract byte zone

Field zone value (for zoned BCD's).

Returns:

zone

Default:

15

prefixlength

public abstract int prefixlength

Prefix length (for variable length strings).

Returns:

prefix length

Default:

2

endianess

public abstract ExtEndian endianess

Byte order. Default is little endian.

Returns:

little endian or big endian

Default:

dk.vajhoej.record.ExtEndian.CONTEXT

pad

public abstract boolean pad

Pad to length (for fixed length strings).

Returns:

whether to pad

Default:

false

padchar

public abstract char padchar

Pad character (for fixed length strings with pad=true). Important: must be part of ASCII aka value in range 0 to 127.

Returns:

pad character

Default:

32