org.apache.camel.dataformat.bindy.annotation
Annotation Type FixedLengthRecord

@Documented
@Retention(value=RUNTIME)
public @interface FixedLengthRecord

This annotation represents the root class of the model. When a fixed-length record must be described in the model we will use this annotation to split the data during the unmarshal process.

Optional Element Summary

String	crlf Character to be used to add a carriage return after each record (optional) Three values can be used : WINDOWS, UNIX or MAC
boolean	hasFooter Indicates that the record(s) of this type may be followed by a single footer record at the end of the file
boolean	hasHeader Indicates that the record(s) of this type may be preceded by a single header record at the beginning of in the file
boolean	ignoreTrailingChars Indicates whether trailing characters beyond the last mapped field may be ignored
boolean	isFooter Identifies this FixedLengthRecord as a footer record, which may be used as the last record in the file
boolean	isHeader Identifies this FixedLengthRecord as a header record, which may precede all other records in the file
int	length The fixed length of the record.
String	name Name describing the record (optional)
char	paddingChar The char to pad with.
boolean	skipFooter Configures the data format to skip marshalling / unmarshalling of the footer record
boolean	skipHeader Configures the data format to skip marshalling / unmarshalling of the header record

name

public abstract String name

Name describing the record (optional)

Returns:

String

Default:

""

crlf

public abstract String crlf

Character to be used to add a carriage return after each record (optional) Three values can be used : WINDOWS, UNIX or MAC

Returns:

String

Default:

"WINDOWS"

paddingChar

public abstract char paddingChar

The char to pad with.

Returns:

the char to pad with if the record is set to a fixed length;

Default:

32

length

public abstract int length

The fixed length of the record. It means that the record will always be that long padded with {#paddingChar()}'s

Returns:

the length of the record.

Default:

0

hasHeader

public abstract boolean hasHeader

Indicates that the record(s) of this type may be preceded by a single header record at the beginning of in the file

Default:

false

hasFooter

public abstract boolean hasFooter

Indicates that the record(s) of this type may be followed by a single footer record at the end of the file

Default:

false

skipHeader

public abstract boolean skipHeader

Configures the data format to skip marshalling / unmarshalling of the header record

Default:

false

skipFooter

public abstract boolean skipFooter

Configures the data format to skip marshalling / unmarshalling of the footer record

Default:

false

isHeader

public abstract boolean isHeader

Identifies this FixedLengthRecord as a header record, which may precede all other records in the file

Default:

false

isFooter

public abstract boolean isFooter

Identifies this FixedLengthRecord as a footer record, which may be used as the last record in the file

Default:

false

ignoreTrailingChars

public abstract boolean ignoreTrailingChars

Indicates whether trailing characters beyond the last mapped field may be ignored

Default:

false