Index
All Classes and Interfaces|All Packages
A
- AbstractColumn - Class in io.github.kelsoncm.fwf.columns
-
Base abstract class representing a column within a Fixed Width File layout.
- AbstractColumn(String, int) - Constructor for class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Constructs a new
AbstractColumnwith a name and size. - AbstractColumn(String, int, String) - Constructor for class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Constructs a new
AbstractColumnwith a name, size, and description.
C
- calculateSize(String, String, int) - Static method in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Calculates column size in characters based on a sample formatting execution.
- CharColumn - Class in io.github.kelsoncm.fwf.columns
-
Character column representing a left-aligned, space-padded string.
- CharColumn(String, int) - Constructor for class io.github.kelsoncm.fwf.columns.CharColumn
-
Constructs a new
CharColumnwith a name and size. - CharColumn(String, int, String) - Constructor for class io.github.kelsoncm.fwf.columns.CharColumn
-
Constructs a new
CharColumnwith a name, size, and description. - columns - Variable in class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Ordered list of column definitions for this row.
- convertPythonFormatToJavaPattern(String) - Static method in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Converts Python strftime format tokens to Java DateTimeFormatter pattern symbols.
D
- DateColumn - Class in io.github.kelsoncm.fwf.columns
-
Date column supporting custom formatting and zero-padding for null values.
- DateColumn(String) - Constructor for class io.github.kelsoncm.fwf.columns.DateColumn
-
Constructs a new
DateColumnwith a name, defaulting to format"%d%m%Y". - DateColumn(String, String) - Constructor for class io.github.kelsoncm.fwf.columns.DateColumn
-
Constructs a new
DateColumnwith a name and format. - DateColumn(String, String, String) - Constructor for class io.github.kelsoncm.fwf.columns.DateColumn
-
Constructs a new
DateColumnwith a name, format, and description. - DateTimeColumn - Class in io.github.kelsoncm.fwf.columns
-
DateTime column supporting custom Python-style date-time format placeholders and zero-padding.
- DateTimeColumn(String) - Constructor for class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Constructs a new
DateTimeColumnwith a name, defaulting to format"%d%m%Y%H%M". - DateTimeColumn(String, String) - Constructor for class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Constructs a new
DateTimeColumnwith a name and format. - DateTimeColumn(String, String, String) - Constructor for class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Constructs a new
DateTimeColumnwith a name, format, and description. - DateTimeColumn(String, String, String, int) - Constructor for class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Protected constructor allowing sub-classes to specify the required number of format specifiers.
- decimals - Variable in class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Number of implicit decimal places.
- description - Variable in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Human-readable description of the column.
- DetailRowDescriptor - Class in io.github.kelsoncm.fwf.descriptors
-
Row descriptor specialized for detail (body) records.
- DetailRowDescriptor(List) - Constructor for class io.github.kelsoncm.fwf.descriptors.DetailRowDescriptor
-
Constructs a new
DetailRowDescriptorwith a list of column definitions.
F
- FileDescriptor - Class in io.github.kelsoncm.fwf.descriptors
-
Descriptor representing the layout structure of a Fixed Width File.
- FileDescriptor(List) - Constructor for class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Constructs a new
FileDescriptorwith detail descriptors only. - FileDescriptor(List, HeaderRowDescriptor) - Constructor for class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Constructs a new
FileDescriptorwith detail and header descriptors. - FileDescriptor(List, HeaderRowDescriptor, FooterRowDescriptor) - Constructor for class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Constructs a new
FileDescriptorwith detail, header, and footer descriptors. - FooterRowDescriptor - Class in io.github.kelsoncm.fwf.descriptors
-
Row descriptor specialized for footer records.
- FooterRowDescriptor(List) - Constructor for class io.github.kelsoncm.fwf.descriptors.FooterRowDescriptor
-
Constructs a new
FooterRowDescriptorwith a list of column definitions. - format - Variable in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
The Python-style format string (e.g.
- formatter - Variable in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
The compiled
DateTimeFormatterinstance.
G
- getColumns() - Method in class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Gets the list of column definitions.
- getDecimals() - Method in class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Gets the number of implicit decimal places.
- getDescription() - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Gets the column description.
- getDetails() - Method in class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Gets the list of detail row descriptors.
- getEnd() - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Calculates and returns the 1-based end position of the column.
- getFooter() - Method in class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Gets the footer row descriptor.
- getFormat() - Method in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Gets the Python-style format string.
- getHeader() - Method in class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Gets the header row descriptor.
- getLineNum() - Method in class io.github.kelsoncm.fwf.readers.Reader
-
Gets the 1-based index of the line currently being processed.
- getLinesCount() - Method in class io.github.kelsoncm.fwf.readers.Reader
-
Gets the total number of lines in the file.
- getLineSize() - Method in class io.github.kelsoncm.fwf.descriptors.FileDescriptor
-
Gets the expected line size (in characters) for the file.
- getLineSize() - Method in class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Gets the total line size (in characters) required by this row.
- getName() - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Gets the column name.
- getSize() - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Gets the column size in characters.
- getStart() - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Gets the 1-based start position of the column.
- getValues(String) - Method in class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Parses a raw line string into a map of column names to parsed values.
H
- hasNext() - Method in class io.github.kelsoncm.fwf.readers.Reader
-
Checks if more lines remain to be read.
- HeaderRowDescriptor - Class in io.github.kelsoncm.fwf.descriptors
-
Row descriptor specialized for header records.
- HeaderRowDescriptor(List) - Constructor for class io.github.kelsoncm.fwf.descriptors.HeaderRowDescriptor
-
Constructs a new
HeaderRowDescriptorwith a list of column definitions.
I
- io.github.kelsoncm.fwf.columns - package io.github.kelsoncm.fwf.columns
- io.github.kelsoncm.fwf.descriptors - package io.github.kelsoncm.fwf.descriptors
- io.github.kelsoncm.fwf.readers - package io.github.kelsoncm.fwf.readers
- io.github.kelsoncm.fwf.renders - package io.github.kelsoncm.fwf.renders
- iterator() - Method in class io.github.kelsoncm.fwf.readers.Reader
-
Returns an iterator over the parsed row maps.
J
- javaPattern - Variable in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
The converted Java
DateTimeFormatterpattern string.
N
- name - Variable in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
The unique name of the column.
- next() - Method in class io.github.kelsoncm.fwf.readers.Reader
-
Reads and parses the next line into a map of column names to parsed values.
P
- PositiveDecimalColumn - Class in io.github.kelsoncm.fwf.columns
-
Positive decimal column with a fixed number of decimal places, formatted with leading zeros.
- PositiveDecimalColumn(String, int) - Constructor for class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Constructs a new
PositiveDecimalColumnwith a name and size, defaulting to 2 decimals. - PositiveDecimalColumn(String, int, int) - Constructor for class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Constructs a new
PositiveDecimalColumnwith a name, size, and decimals. - PositiveDecimalColumn(String, int, int, String) - Constructor for class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Constructs a new
PositiveDecimalColumnwith a name, size, decimals, and description. - PositiveIntegerColumn - Class in io.github.kelsoncm.fwf.columns
-
Positive integer column represented as a zero-padded string of digits.
- PositiveIntegerColumn(String, int) - Constructor for class io.github.kelsoncm.fwf.columns.PositiveIntegerColumn
-
Constructs a new
PositiveIntegerColumnwith a name and size. - PositiveIntegerColumn(String, int, String) - Constructor for class io.github.kelsoncm.fwf.columns.PositiveIntegerColumn
-
Constructs a new
PositiveIntegerColumnwith a name, size, and description.
R
- Reader - Class in io.github.kelsoncm.fwf.readers
-
Sequential reader for Fixed Width Files.
- Reader(Object, FileDescriptor) - Constructor for class io.github.kelsoncm.fwf.readers.Reader
-
Constructs a new
Readerdefaulting to newline delimiter"\n\r". - Reader(Object, FileDescriptor, String) - Constructor for class io.github.kelsoncm.fwf.readers.Reader
-
Constructs a new
Readerwith a content source, file descriptor, and newline delimiter. - renderAsHtml(FileDescriptor, Writer) - Static method in class io.github.kelsoncm.fwf.renders.RenderUtils
-
Renders the layout specification of a
FileDescriptoras HTML tables into aWriter. - renderAsMarkdown(FileDescriptor, Writer) - Static method in class io.github.kelsoncm.fwf.renders.RenderUtils
-
Renders the layout specification of a
FileDescriptoras Markdown tables into aWriter. - renderAsRst(FileDescriptor, Writer) - Static method in class io.github.kelsoncm.fwf.renders.RenderUtils
-
Renders the layout specification of a
FileDescriptoras ReStructuredText (RST) tables into aWriter. - RenderUtils - Class in io.github.kelsoncm.fwf.renders
-
Utility class to export layout specifications of a
FileDescriptorinto Markdown, ReStructuredText (RST), and HTML tables. - requiredFormatNumElements - Variable in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
The required number of Python format specifiers in the format string.
- RightCharColumn - Class in io.github.kelsoncm.fwf.columns
-
Character column representing a right-aligned, space-padded string.
- RightCharColumn(String, int) - Constructor for class io.github.kelsoncm.fwf.columns.RightCharColumn
-
Constructs a new
RightCharColumnwith a name and size. - RightCharColumn(String, int, String) - Constructor for class io.github.kelsoncm.fwf.columns.RightCharColumn
-
Constructs a new
RightCharColumnwith a name, size, and description. - RowDescriptor - Class in io.github.kelsoncm.fwf.descriptors
-
Descriptor for a row consisting of multiple ordered columns.
- RowDescriptor(List) - Constructor for class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Constructs a new
RowDescriptorwith a list of column definitions.
S
- setStart(Integer) - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Sets the 1-based start position of the column.
- size - Variable in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
The fixed character length (size) of the column.
- start - Variable in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
1-based starting character position of the column within a line.
T
- TimeColumn - Class in io.github.kelsoncm.fwf.columns
-
Time column supporting custom formatting and zero-padding for null values.
- TimeColumn(String) - Constructor for class io.github.kelsoncm.fwf.columns.TimeColumn
-
Constructs a new
TimeColumnwith a name, defaulting to format"%H%M". - TimeColumn(String, String) - Constructor for class io.github.kelsoncm.fwf.columns.TimeColumn
-
Constructs a new
TimeColumnwith a name and format. - TimeColumn(String, String, String) - Constructor for class io.github.kelsoncm.fwf.columns.TimeColumn
-
Constructs a new
TimeColumnwith a name, format, and description. - toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Formats a domain value into a fixed-width string representation of exact column size.
- toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.CharColumn
-
Formats a String or null into a left-aligned, space-padded string of exact column size.
- toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.DateColumn
-
Formats a
LocalDateor null into a fixed-width string of exact column size. - toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Formats a
LocalDateTimeor null into a fixed-width string of exact column size. - toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Formats a non-negative Double/Float or null into a zero-padded string of exact column size.
- toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.PositiveIntegerColumn
-
Formats a non-negative Number or null into a zero-padded string of exact column size.
- toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.RightCharColumn
-
Formats a String or null into a right-aligned, space-padded string of exact column size.
- toStr(Object) - Method in class io.github.kelsoncm.fwf.columns.TimeColumn
-
Formats a
LocalTimeor null into a fixed-width string of exact column size. - toValue(String) - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Converts a raw fixed-width string slice into a parsed object value.
- toValue(String) - Method in class io.github.kelsoncm.fwf.columns.CharColumn
-
Converts a raw fixed-width string slice into a trimmed string value.
- toValue(String) - Method in class io.github.kelsoncm.fwf.columns.DateColumn
-
Converts a raw fixed-width date string slice into a
LocalDatevalue. - toValue(String) - Method in class io.github.kelsoncm.fwf.columns.DateTimeColumn
-
Converts a raw fixed-width date-time string slice into a
LocalDateTimevalue. - toValue(String) - Method in class io.github.kelsoncm.fwf.columns.PositiveDecimalColumn
-
Converts a raw fixed-width zero-padded integer slice into a Double value with decimal precision.
- toValue(String) - Method in class io.github.kelsoncm.fwf.columns.PositiveIntegerColumn
-
Converts a raw fixed-width zero-padded integer slice into an Integer value.
- toValue(String) - Method in class io.github.kelsoncm.fwf.columns.TimeColumn
-
Converts a raw fixed-width time string slice into a
LocalTimevalue.
V
- validatePositions() - Method in class io.github.kelsoncm.fwf.descriptors.RowDescriptor
-
Validates that column positions start at 1 and are strictly contiguous.
- validateToStrSize(String) - Method in class io.github.kelsoncm.fwf.columns.AbstractColumn
-
Validates that the formatted string output exactly matches the column size.
All Classes and Interfaces|All Packages