Module com.blackhillsoftware.easysmf.je

Package com.blackhillsoftware.smf.readerbuilder

Class StreamReaderBuilder<T extends StreamReaderBuilder<T>>

java.lang.Object

com.blackhillsoftware.smf.SmfRecordReaderBuilder

com.blackhillsoftware.smf.readerbuilder.StreamReaderBuilder<T>

public class StreamReaderBuilder<T extends StreamReaderBuilder<T>>
extends SmfRecordReaderBuilder

Build a SmfRecordReader to read from an InputStream.

Obtain the StreamReaderBuilder from SmfRecordReader.streamBuilder(InputStream)

Method Summary

Modifier and Type	Method	Description
SmfRecordReader	build()	Build the SmfRecordReader.
StreamReaderBuilder<T>	include(int smfType)	Include a SMF record type - see SmfRecordReader.include(int)
StreamReaderBuilder<T>	include(int smfType, int subtype)	Include a SMF record type and subtype - see SmfRecordReader.include(int, int)
StreamReaderBuilder<T>	recfm(SmfRecordReader.RecordFormat recfm)	Specify the record format for the data in this stream

Methods inherited from class java.lang.Object

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

Method Details

recfm

public StreamReaderBuilder<T> recfm(SmfRecordReader.RecordFormat recfm)

Specify the record format for the data in this stream

Parameters:

recfm - the RecordFormat - default AUTODETECT

Returns:

this StreamReaderBuilder to allow method chaining

include

public StreamReaderBuilder<T> include(int smfType)

Description copied from class: SmfRecordReaderBuilder

Include a SMF record type - see SmfRecordReader.include(int)

Specified by:

include in class SmfRecordReaderBuilder

Parameters:

smfType - the SMF type to include

Returns:

this SmfRecordReaderBuilder to allow method chaining

include

public StreamReaderBuilder<T> include(int smfType,
 int subtype)

Description copied from class: SmfRecordReaderBuilder

Include a SMF record type and subtype - see SmfRecordReader.include(int, int)

Specified by:

include in class SmfRecordReaderBuilder

Parameters:

smfType - the SMF type to include

subtype - the SMF subtype to include

Returns:

this SmfRecordReaderBuilder to allow method chaining

build

public SmfRecordReader build()
                      throws IOException

Description copied from class: SmfRecordReaderBuilder

Build the SmfRecordReader. Consider calling this method in a try-with-resources statement to ensure the SmfRecordReader is closed.

Specified by:

build in class SmfRecordReaderBuilder

Returns:

the resulting SmfRecordReader

Throws:

IOException - if an I/O error occurs