Module org.fissore.jrecordbind

Package org.fissore.jrecordbind

Class Unmarshaller<E>

java.lang.Object

org.fissore.jrecordbind.Unmarshaller<E>

public class Unmarshaller<E>
extends Object

Transforms an input reader into beans. You can consume the transformed beans by calling unmarshallToIterator(Reader) which returns an Iterator, or by calling unmarshallToStream(Reader), which returns a Stream.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Converter>	converters
protected RecordDefinition	definition
protected Map<String,Padder>	padders
protected org.fissore.jrecordbind.PropertyUtils	propertyUtils

Constructor Summary

Constructors

Constructor	Description
Unmarshaller(RecordDefinition definition)	Creates a new Unmarshaller, with the specified record definition and using the default LineReader implementation
Unmarshaller(RecordDefinition definition, LineReader lineReader)	Creates a new Unmarshaller, with the specified record definition and using the specified LineReader implementation
Unmarshaller(RecordDefinition definition, LineReader lineReader, Map<String,Converter> converters, Map<String,Padder> padders)	Creates a new Unmarshaller, with the specified record definition and using the specified LineReader implementation, and with user provided instances of converters and padders.

Method Summary

Modifier and Type	Method	Description
protected Converter	getConverter(RecordDefinition.Property property)	Gets the converter for the specified property or an instance of StringConverter
String	getCurrentJunk()	Returns the current internal buffer content.
protected Padder	getPadder(RecordDefinition currentDefinition, RecordDefinition.Property property)	Gets the padder for the specified property or the default one specified by the record definition
Iterator<E>	unmarshallToIterator(Reader input)	Unmarshalls the input fixed-length file, a bean at a time
Stream<E>	unmarshallToStream(Reader input)	Like unmarshallToIterator(Reader), but returns a Stream instead of an Iterator

Methods inherited from class java.lang.Object

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

Field Detail

converters

protected final Map<String,Converter> converters

padders

protected final Map<String,Padder> padders

definition

protected final RecordDefinition definition

propertyUtils

protected final org.fissore.jrecordbind.PropertyUtils propertyUtils

Constructor Detail

Unmarshaller

public Unmarshaller(RecordDefinition definition)

Creates a new Unmarshaller, with the specified record definition and using the default LineReader implementation

Parameters:

definition - the record definition

Unmarshaller

public Unmarshaller(RecordDefinition definition,
                    LineReader lineReader)

Creates a new Unmarshaller, with the specified record definition and using the specified LineReader implementation

Parameters:

definition - the record definition

lineReader - a custom implementation of the LineReader

Unmarshaller

public Unmarshaller(RecordDefinition definition,
                    LineReader lineReader,
                    Map<String,Converter> converters,
                    Map<String,Padder> padders)

Creates a new Unmarshaller, with the specified record definition and using the specified LineReader implementation, and with user provided instances of converters and padders.

Parameters:

definition - the record definition

lineReader - a custom implementation of the LineReader

converters - user provided instances of converters

padders - user provided instances of padders

Method Detail

getCurrentJunk

public String getCurrentJunk()

Returns the current internal buffer content. If called right after a Iterator.next() call, it will return what JRecordBind wasn't able to unmarshall. Usually called after the Iterator.hasNext() has returned false to report the user about the "junk" found in the text file

Returns:

the current "junk" stored in the internal buffer

unmarshallToIterator

public Iterator<E> unmarshallToIterator(Reader input)

Unmarshalls the input fixed-length file, a bean at a time

Parameters:

input - the input fixed-length file

Returns:

an Iterator: each next() call will give back the next bean

unmarshallToStream

public Stream<E> unmarshallToStream(Reader input)

Like unmarshallToIterator(Reader), but returns a Stream instead of an Iterator

Parameters:

input - the input fixed-length file

Returns:

a stream of beans

getPadder

protected Padder getPadder(RecordDefinition currentDefinition,
                           RecordDefinition.Property property)

Gets the padder for the specified property or the default one specified by the record definition

Parameters:

currentDefinition - the record definition

property - the property

Returns:

a padder instance

getConverter

protected Converter getConverter(RecordDefinition.Property property)

Gets the converter for the specified property or an instance of StringConverter

Parameters:

property - the property

Returns:

a converter instance