Package org.apache.commons.io.input
Class Tailer.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<Tailer,Tailer.Builder>
org.apache.commons.io.build.AbstractOriginSupplier<Tailer,Tailer.Builder>
org.apache.commons.io.build.AbstractStreamBuilder<Tailer,Tailer.Builder>
org.apache.commons.io.input.Tailer.Builder
- All Implemented Interfaces:
IOSupplier<Tailer>
- Enclosing class:
Tailer
Builds a new
Tailer.
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()Builds a newTailer.setDelayDuration(Duration delayDuration) Sets the delay duration. null resets to the default delay of one second.setExecutorService(ExecutorService executorService) Sets the executor service to use when startThread is true.protected Tailer.BuildersetOrigin(AbstractOrigin<?, ?> origin) Sets the origin.setReOpen(boolean reOpen) Sets the re-open behavior.setStartThread(boolean startThread) Sets the daemon thread startup behavior.setTailable(Tailer.Tailable tailable) Sets the tailable.setTailerListener(TailerListener tailerListener) Sets the listener.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, setOpenOptionsMethods 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, setWriterMethods inherited from class org.apache.commons.io.build.AbstractSupplier
asThisMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, getUnchecked
-
Constructor Details
-
Method Details
-
get
Builds a newTailer.This builder uses the following aspects:
AbstractStreamBuilder.getBufferSize()AbstractStreamBuilder.getCharset()Tailer.TailableTailerListener- delayDuration
- tailFromEnd
- reOpen
- Returns:
- a new instance.
- See Also:
-
setDelayDuration
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:
thisinstance.
-
setExecutorService
Sets the executor service to use when startThread is true.- Parameters:
executorService- the executor service to use when startThread is true.- Returns:
thisinstance.
-
setOrigin
Sets the origin.- Overrides:
setOriginin classAbstractOriginSupplier<Tailer,Tailer.Builder> - Parameters:
origin- the new origin.- Returns:
thisinstance.- Throws:
UnsupportedOperationException- if the origin cannot be converted to a Path.
-
setReOpen
Sets the re-open behavior.- Parameters:
reOpen- whether to close/reopen the file between chunks- Returns:
thisinstance.
-
setStartThread
Sets the daemon thread startup behavior.- Parameters:
startThread- whether to create a daemon thread automatically.- Returns:
thisinstance.
-
setTailable
Sets the tailable.- Parameters:
tailable- the tailable.- Returns:
thisinstance.
-
setTailerListener
Sets the listener.- Parameters:
tailerListener- the listener.- Returns:
thisinstance.
-
setTailFromEnd
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:
thisinstance.
-