Class FileDescriptor

java.lang.Object

io.github.kelsoncm.fwf.descriptors.FileDescriptor

public class FileDescriptor
extends Object

Descriptor representing the layout structure of a Fixed Width File.

Contains details, optional header, and optional footer descriptors. Validates that line sizes across all sections are equal.

Constructor Summary

Constructors

Constructor	Description
FileDescriptor(List<DetailRowDescriptor> details)	Constructs a new FileDescriptor with detail descriptors only.
FileDescriptor(List<DetailRowDescriptor> details, HeaderRowDescriptor header)	Constructs a new FileDescriptor with detail and header descriptors.
FileDescriptor(List<DetailRowDescriptor> details, HeaderRowDescriptor header, FooterRowDescriptor footer)	Constructs a new FileDescriptor with detail, header, and footer descriptors.

Method Summary

Modifier and Type	Method	Description
List<DetailRowDescriptor>	getDetails()	Gets the list of detail row descriptors.
FooterRowDescriptor	getFooter()	Gets the footer row descriptor.
HeaderRowDescriptor	getHeader()	Gets the header row descriptor.
int	getLineSize()	Gets the expected line size (in characters) for the file.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileDescriptor

public FileDescriptor(List<DetailRowDescriptor> details,
 HeaderRowDescriptor header,
 FooterRowDescriptor footer)

Constructs a new FileDescriptor with detail, header, and footer descriptors.

Parameters:

details - list of DetailRowDescriptor instances, must not be empty

header - optional HeaderRowDescriptor, or null if file has no header

footer - optional FooterRowDescriptor, or null if file has no footer

Throws:

IllegalArgumentException - if details is null or empty, or line sizes do not match

FileDescriptor

public FileDescriptor(List<DetailRowDescriptor> details,
 HeaderRowDescriptor header)

Constructs a new FileDescriptor with detail and header descriptors.

Parameters:

details - list of DetailRowDescriptor instances

header - optional HeaderRowDescriptor

FileDescriptor

public FileDescriptor(List<DetailRowDescriptor> details)

Constructs a new FileDescriptor with detail descriptors only.

Parameters:

details - list of DetailRowDescriptor instances

Method Details

getDetails

public List<DetailRowDescriptor> getDetails()

Gets the list of detail row descriptors.

Returns:

unmodifiable list of detail descriptors

getHeader

public HeaderRowDescriptor getHeader()

Gets the header row descriptor.

Returns:

header descriptor or null if not present

getFooter

public FooterRowDescriptor getFooter()

Gets the footer row descriptor.

Returns:

footer descriptor or null if not present

getLineSize

public int getLineSize()

Gets the expected line size (in characters) for the file.

Returns:

line size in characters