Package com.arpnetworking.metrics.common.sources

Class FileSource.Builder<T>

java.lang.Object

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

com.arpnetworking.metrics.common.sources.BaseSource.Builder<FileSource.Builder<T>,FileSource<T>>

com.arpnetworking.metrics.common.sources.FileSource.Builder<T>

Type Parameters:

T - the type parsed from the parser.

All Implemented Interfaces:

com.arpnetworking.commons.builder.Builder<FileSource<T>>

Enclosing class:

FileSource<T>

public static class FileSource.Builder<T>
extends BaseSource.Builder<FileSource.Builder<T>,FileSource<T>>

Implementation of builder pattern for FileSource.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
protected FileSource.Builder<T>	self()	Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.
final FileSource.Builder<T>	setInitialPosition(InitialPosition value)	Sets whether to tail the file from its end or from its start.
final FileSource.Builder<T>	setInterval(Duration value)	Sets file read interval in milliseconds.
final FileSource.Builder<T>	setParser(Parser<T,byte[]> value)	Sets Parser.
final FileSource.Builder<T>	setSourceFile(Path value)	Sets source file.
final FileSource.Builder<T>	setStateFile(Path value)	Sets state file.

Methods inherited from class com.arpnetworking.metrics.common.sources.BaseSource.Builder

setName

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

setSourceFile

public final FileSource.Builder<T> setSourceFile(Path value)

Sets source file. Cannot be null.

Parameters:

value - The file path.

Returns:

This instance of FileSource.Builder.

setInterval

public final FileSource.Builder<T> setInterval(Duration value)

Sets file read interval in milliseconds. Cannot be null, minimum 1. Default is 500 milliseconds.

Parameters:

value - The file read interval in milliseconds.

Returns:

This instance of FileSource.Builder.

setInitialPosition

public final FileSource.Builder<T> setInitialPosition(InitialPosition value)

Sets whether to tail the file from its end or from its start. Default InitialPosition.START;

Parameters:

value - Initial position to tail from.

Returns:

This instance of FileSource.Builder.

setParser

public final FileSource.Builder<T> setParser(Parser<T,byte[]> value)

Sets Parser. Cannot be null.

Parameters:

value - The Parser.

Returns:

This instance of FileSource.Builder.

setStateFile

public final FileSource.Builder<T> setStateFile(Path value)

Sets state file. Optional. Default is null. If null, uses a NoPositionStore in the underlying tailer.

Parameters:

value - The state file.

Returns:

This instance of FileSource.Builder.

self

protected FileSource.Builder<T> self()

Description copied from class: BaseSource.Builder

Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.

Specified by:

self in class BaseSource.Builder<FileSource.Builder<T>,FileSource<T>>

Returns:

instance with correct BaseSource.Builder class type.