Annotation Type FixedLengthRecord
-
@Documented @Retention(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
Optional Elements Modifier and Type Optional Element Description boolean
countGrapheme
Indicates how chars are countedString
crlf
Character to be used to add a carriage return after each record (optional).String
eol
Character to be used to process considering end of line after each record while unmarshalling (optional - default: "", which help default JDK provided line delimiter to be used unless any other line delimiter provided) This option is used only during unmarshalling, where marshalling uses system default provided line delimiter as "WINDOWS" unless any other value is provided.Class<?>
footer
Indicates that the record(s) of this type may be followed by a single footer record at the end of the fileClass<?>
header
Indicates that the record(s) of this type may be preceded by a single header record at the beginning of in the fileboolean
ignoreMissingChars
Indicates whether too short lines will be ignoredboolean
ignoreTrailingChars
Indicates that characters beyond the last mapped filed can be ignored when unmarshalling / parsing.int
length
The fixed length of the record (number of characters).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.
-
-
-
Element Detail
-
name
String name
Name describing the record (optional)- Returns:
- String
- Default:
- ""
-
-
-
crlf
String crlf
Character to be used to add a carriage return after each record (optional). Possible values: WINDOWS, UNIX, MAC, or custom. This option is used only during marshalling, whereas unmarshalling uses system default JDK provided line delimiter unless eol is customized.- Returns:
- String
- Default:
- "WINDOWS"
-
-
-
eol
String eol
Character to be used to process considering end of line after each record while unmarshalling (optional - default: "", which help default JDK provided line delimiter to be used unless any other line delimiter provided) This option is used only during unmarshalling, where marshalling uses system default provided line delimiter as "WINDOWS" unless any other value is provided.- Returns:
- String
- Default:
- ""
-
-
-
header
Class<?> header
Indicates that the record(s) of this type may be preceded by a single header record at the beginning of in the file- Default:
- void.class
-
-
-
footer
Class<?> footer
Indicates that the record(s) of this type may be followed by a single footer record at the end of the file- Default:
- void.class
-
-