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
-
Method Summary
Modifier and TypeMethodDescriptionprotected FileSource.Builder<T>
self()
Called by setters to always return appropriate subclass ofBaseSource.Builder
, even from setters of base class.final FileSource.Builder<T>
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>
SetsParser
.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
-
Constructor Details
-
Builder
public Builder()Public constructor.
-
-
Method Details
-
setSourceFile
Sets source file. Cannot be null.- Parameters:
value
- The file path.- Returns:
- This instance of
FileSource.Builder
.
-
setInterval
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
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
SetsParser
. Cannot be null.- Parameters:
value
- TheParser
.- Returns:
- This instance of
FileSource.Builder
.
-
setStateFile
Sets state file. Optional. Default is null. If null, uses aNoPositionStore
in the underlying tailer.- Parameters:
value
- The state file.- Returns:
- This instance of
FileSource.Builder
.
-
self
Description copied from class:BaseSource.Builder
Called by setters to always return appropriate subclass ofBaseSource.Builder
, even from setters of base class.- Specified by:
self
in classBaseSource.Builder<FileSource.Builder<T>,
FileSource<T>> - Returns:
- instance with correct
BaseSource.Builder
class type.
-