com.github.davidmoten.rx

Class FileObservable.TailerBuilder

java.lang.Object

com.github.davidmoten.rx.FileObservable.TailerBuilder

Enclosing class:

FileObservable

public static final class FileObservable.TailerBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
FileObservable.TailerBuilder	charset(Charset charset) The charset of the file.
FileObservable.TailerBuilder	charset(String charset) The charset of the file.
FileObservable.TailerBuilder	chunkSize(int chunkSize) Emissions from the tailed file will be no bigger than this.
FileObservable.TailerBuilder	file(File file) The file to tail.
FileObservable.TailerBuilder	file(String filename)
FileObservable.TailerBuilder	onWatchStarted(rx.functions.Action0 onWatchStarted)
FileObservable.TailerBuilder	sampleTimeMs(long sampleTimeMs) Specifies sampling to apply to the source observable (which could be very busy if a lot of writes are occurring for example).
FileObservable.TailerBuilder	source(rx.Observable<?> source)
FileObservable.TailerBuilder	startPosition(long startPosition) The startPosition in bytes in the file to commence the tail from.
rx.Observable<byte[]>	tail()
rx.Observable<String>	tailText()
FileObservable.TailerBuilder	utf8()

Methods inherited from class java.lang.Object

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

Method Detail

file

public FileObservable.TailerBuilder file(File file)

The file to tail.

Parameters:

file - file to tail

Returns:

the builder (this)

file

public FileObservable.TailerBuilder file(String filename)

onWatchStarted

public FileObservable.TailerBuilder onWatchStarted(rx.functions.Action0 onWatchStarted)

startPosition

public FileObservable.TailerBuilder startPosition(long startPosition)

The startPosition in bytes in the file to commence the tail from. 0 = start of file. Defaults to 0.

Parameters:

startPosition - start position

Returns:

this

sampleTimeMs

public FileObservable.TailerBuilder sampleTimeMs(long sampleTimeMs)

Specifies sampling to apply to the source observable (which could be very busy if a lot of writes are occurring for example). Sampling is only applied to file updates (MODIFY and OVERFLOW), file creation events are always passed through. File deletion events are ignored (in fact are not requested of NIO).

Parameters:

sampleTimeMs - sample time in ms

Returns:

this

chunkSize

public FileObservable.TailerBuilder chunkSize(int chunkSize)

Emissions from the tailed file will be no bigger than this.

Parameters:

chunkSize - chunk size in bytes

Returns:

this

charset

public FileObservable.TailerBuilder charset(Charset charset)

The charset of the file. Only used for tailing a text file.

Parameters:

charset - charset to decode with

Returns:

this

charset

public FileObservable.TailerBuilder charset(String charset)

The charset of the file. Only used for tailing a text file.

Parameters:

charset - charset to decode the file with

Returns:

this

utf8

public FileObservable.TailerBuilder utf8()

source

public FileObservable.TailerBuilder source(rx.Observable<?> source)

tail

public rx.Observable<byte[]> tail()

tailText

public rx.Observable<String> tailText()