Package org.apache.commons.io.input
Class Tailer.Builder
- java.lang.Object
-
- org.apache.commons.io.build.AbstractSupplier<T,B>
-
- org.apache.commons.io.build.AbstractOriginSupplier<T,B>
-
- org.apache.commons.io.build.AbstractStreamBuilder<Tailer,Tailer.Builder>
-
- org.apache.commons.io.input.Tailer.Builder
-
- All Implemented Interfaces:
IOSupplier<Tailer>
- Enclosing class:
- Tailer
public static class Tailer.Builder extends AbstractStreamBuilder<Tailer,Tailer.Builder>
Builds a newTailer
.For example:
Tailer t = Tailer.builder() .setPath(path) .setCharset(StandardCharsets.UTF_8) .setDelayDuration(Duration.ofSeconds(1)) .setExecutorService(Executors.newSingleThreadExecutor(Builder::newDaemonThread)) .setReOpen(false) .setStartThread(true) .setTailable(tailable) .setTailerListener(tailerListener) .setTailFromEnd(false) .get();
- Since:
- 2.12.0
- See Also:
get()
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Tailer
get()
Builds a newTailer
.Tailer.Builder
setDelayDuration(java.time.Duration delayDuration)
Sets the delay duration.Tailer.Builder
setExecutorService(java.util.concurrent.ExecutorService executorService)
Sets the executor service to use when startThread is true.protected Tailer.Builder
setOrigin(AbstractOrigin<?,?> origin)
Sets the origin.Tailer.Builder
setReOpen(boolean reOpen)
Sets the re-open behavior.Tailer.Builder
setStartThread(boolean startThread)
Sets the daemon thread startup behavior.Tailer.Builder
setTailable(Tailer.Tailable tailable)
Sets the tailable.Tailer.Builder
setTailerListener(TailerListener tailerListener)
Sets the listener.Tailer.Builder
setTailFromEnd(boolean end)
Sets the tail start behavior.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
-
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriter
-
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, getUnchecked
-
-
-
-
Constructor Detail
-
Builder
public Builder()
-
-
Method Detail
-
get
public Tailer get()
Builds a newTailer
.This builder use the following aspects:
AbstractStreamBuilder.getBufferSize()
AbstractStreamBuilder.getCharset()
Tailer.Tailable
TailerListener
- delayDuration
- tailFromEnd
- reOpen
- Returns:
- a new instance.
-
setDelayDuration
public Tailer.Builder setDelayDuration(java.time.Duration delayDuration)
Sets the delay duration. null resets to the default delay of one second.- Parameters:
delayDuration
- the delay between checks of the file for new content.- Returns:
this
instance.
-
setExecutorService
public Tailer.Builder setExecutorService(java.util.concurrent.ExecutorService executorService)
Sets the executor service to use when startThread is true.- Parameters:
executorService
- the executor service to use when startThread is true.- Returns:
this
instance.
-
setOrigin
protected Tailer.Builder setOrigin(AbstractOrigin<?,?> origin)
Sets the origin.- Overrides:
setOrigin
in classAbstractOriginSupplier<Tailer,Tailer.Builder>
- Parameters:
origin
- the new origin.- Returns:
this
instance.- Throws:
java.lang.UnsupportedOperationException
- if the origin cannot be converted to a Path.
-
setReOpen
public Tailer.Builder setReOpen(boolean reOpen)
Sets the re-open behavior.- Parameters:
reOpen
- whether to close/reopen the file between chunks- Returns:
this
instance.
-
setStartThread
public Tailer.Builder setStartThread(boolean startThread)
Sets the daemon thread startup behavior.- Parameters:
startThread
- whether to create a daemon thread automatically.- Returns:
this
instance.
-
setTailable
public Tailer.Builder setTailable(Tailer.Tailable tailable)
Sets the tailable.- Parameters:
tailable
- the tailable.- Returns:
this
instance.
-
setTailerListener
public Tailer.Builder setTailerListener(TailerListener tailerListener)
Sets the listener.- Parameters:
tailerListener
- the listener.- Returns:
this
instance.
-
setTailFromEnd
public Tailer.Builder setTailFromEnd(boolean end)
Sets the tail start behavior.- Parameters:
end
- Set to true to tail from the end of the file, false to tail from the beginning of the file.- Returns:
this
instance.
-
-