Package com.arpnetworking.metrics.common.tailer

Class StatefulTailer.Builder

java.lang.Object

com.arpnetworking.commons.builder.OvalBuilder<StatefulTailer>

com.arpnetworking.metrics.common.tailer.StatefulTailer.Builder

All Implemented Interfaces:

com.arpnetworking.commons.builder.Builder<StatefulTailer>

Enclosing class:

StatefulTailer

public static class StatefulTailer.Builder
extends com.arpnetworking.commons.builder.OvalBuilder<StatefulTailer>

Builder implementation for StatefulTailer.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot io)

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
StatefulTailer.Builder	setFile(Path value)	Sets the file to read.
StatefulTailer.Builder	setInitialPosition(InitialPosition initialPosition)	Sets the tailer to start at the current end of the file.
StatefulTailer.Builder	setListener(TailerListener value)	Sets the TailerListener instance.
StatefulTailer.Builder	setMaximumOffsetOnResume(Long maximumOffsetOnResume)	Sets the maximum offset on resume.
StatefulTailer.Builder	setPositionStore(PositionStore value)	Sets the PositionStore to be used to checkpoint the file read position.
StatefulTailer.Builder	setReadInterval(Duration value)	Sets the interval between file reads.

Methods inherited from class com.arpnetworking.commons.builder.OvalBuilder

build, clone, clone, construct, isSelfValidating, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Public constructor.

Method Details

setFile

public StatefulTailer.Builder setFile(Path value)

Sets the file to read. Cannot be null or empty.

Parameters:

value - The file to read.

Returns:

This instance of StatefulTailer.Builder

setPositionStore

public StatefulTailer.Builder setPositionStore(PositionStore value)

Sets the PositionStore to be used to checkpoint the file read position. Cannot be null.

Parameters:

value - The PositionStore instance.

Returns:

This instance of StatefulTailer.Builder

setListener

public StatefulTailer.Builder setListener(TailerListener value)

Sets the TailerListener instance. Cannot be null.

Parameters:

value - The TailerListener instance.

Returns:

This instance of StatefulTailer.Builder

setReadInterval

public StatefulTailer.Builder setReadInterval(Duration value)

Sets the interval between file reads. Optional. Default is 500 milliseconds.

Parameters:

value - The file read interval.

Returns:

This instance of StatefulTailer.Builder

setInitialPosition

public StatefulTailer.Builder setInitialPosition(InitialPosition initialPosition)

Sets the tailer to start at the current end of the file.

Parameters:

initialPosition - The initial position of the tailer

Returns:

This instance of StatefulTailer.Builder

setMaximumOffsetOnResume

public StatefulTailer.Builder setMaximumOffsetOnResume(Long maximumOffsetOnResume)

Sets the maximum offset on resume. Optional. Default is no maximum.

Parameters:

maximumOffsetOnResume - The maximum offset on resume.

Returns:

This instance of StatefulTailer.Builder