Module com.blackhillsoftware.easysmf.je

Package com.blackhillsoftware.smf.readerbuilder

Class LogstreamBuilderLocal<T extends LogstreamBuilderLocal<T>>

java.lang.Object

com.blackhillsoftware.smf.SmfRecordReaderBuilder

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

public class LogstreamBuilderLocal<T extends LogstreamBuilderLocal<T>>
extends SmfRecordReaderBuilder

Intermediate class generated using the builder pattern to read from a logstream and specifying local times - see LogstreamBuilder

Method Summary

Modifier and Type	Method	Description
SmfRecordReader	build()	Build the SmfRecordReader.
LogstreamBuilderLocal<T>	from(LocalDateTime localDateTime)	Specify the start time for the first logstream block to be processed using a LocalDateTime
LogstreamBuilderLocal<T>	from(LocalTime localTime)	Specify the start time for the first logstream block to be processed using a LocalTime
LogstreamBuilderLocal<T>	include(int smfType)	Include a SMF record type - see SmfRecordReader.include(int)
LogstreamBuilderLocal<T>	include(int smfType, int subtype)	Include a SMF record type and subtype - see SmfRecordReader.include(int, int)
LogstreamBuilderLocal<T>	sid(String sid)	Specify the system identifier for the SMF logstream system exit
LogstreamBuilderLocal<T>	smep(Duration smep)	Specify the smart end point used by the SMF logstream system exit
LogstreamBuilderLocal<T>	to(LocalDateTime localDateTime)	Specify the end time for the last logstream block to be processed using a LocalDateTime
LogstreamBuilderLocal<T>	to(LocalTime localTime)	Specify the end time for the last logstream block to be processed using a LocalTime

Methods inherited from class java.lang.Object

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

Method Details

from

public LogstreamBuilderLocal<T> from(LocalTime localTime)

Specify the start time for the first logstream block to be processed using a LocalTime

Parameters:

localTime -

Returns:

this LogstreamBuilderLocal to allow method chaining

from

public LogstreamBuilderLocal<T> from(LocalDateTime localDateTime)

Specify the start time for the first logstream block to be processed using a LocalDateTime

Parameters:

localDateTime - the start date and time

Returns:

this LogstreamBuilderLocal to allow method chaining

to

public LogstreamBuilderLocal<T> to(LocalTime localTime)

Specify the end time for the last logstream block to be processed using a LocalTime

Parameters:

localTime -

Returns:

this LogstreamBuilderLocal to allow method chaining

to

public LogstreamBuilderLocal<T> to(LocalDateTime localDateTime)

Specify the end time for the last logstream block to be processed using a LocalDateTime

Parameters:

localDateTime - the end date and time

Returns:

this LogstreamBuilderLocal to allow method chaining

sid

public LogstreamBuilderLocal<T> sid(String sid)

Specify the system identifier for the SMF logstream system exit

Parameters:

sid - a System ID

Returns:

this LogstreamReaderBuilderCommon to allow method chaining

smep

public LogstreamBuilderLocal<T> smep(Duration smep)

Specify the smart end point used by the SMF logstream system exit

Parameters:

smep - the smart end point duration (less than or equal to 2 hours)

Returns:

this SmfRecordReaderBuilder to allow method chaining

include

public LogstreamBuilderLocal<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 LogstreamBuilderLocal<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