com.github.davidmoten.rx

Class FileObservable.Builder

java.lang.Object

com.github.davidmoten.rx.FileObservable.Builder

Enclosing class:

FileObservable

public static class FileObservable.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
FileObservable.Builder	charset(Charset charset) The charset of the file.
FileObservable.Builder	charset(String charset) The charset of the file.
FileObservable.Builder	chunkSize(int chunkSize) Emissions from the tailed file will be no bigger than this.
FileObservable.Builder	file(File file) The file to tail.
FileObservable.Builder	file(String filename)
FileObservable.Builder	onWatchStarted(rx.functions.Action0 onWatchStarted)
FileObservable.Builder	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.Builder	source(rx.Observable<?> source)
FileObservable.Builder	startPosition(long startPosition) The startPosition in bytes in the file to commence the tail from.
rx.Observable<byte[]>	tail()
rx.Observable<String>	tailText()
FileObservable.Builder	utf8()

Methods inherited from class java.lang.Object

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

Method Detail

file

public FileObservable.Builder file(File file)

The file to tail.

Parameters:

file -

Returns:

this

file

public FileObservable.Builder file(String filename)

onWatchStarted

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

startPosition

public FileObservable.Builder startPosition(long startPosition)

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

Parameters:

startPosition -

Returns:

this

sampleTimeMs

public FileObservable.Builder 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 -

Returns:

this

chunkSize

public FileObservable.Builder chunkSize(int chunkSize)

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

Parameters:

chunkSize -

Returns:

this

charset

public FileObservable.Builder charset(Charset charset)

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

Parameters:

charset -

Returns:

this

charset

public FileObservable.Builder charset(String charset)

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

Parameters:

charset -

Returns:

this

utf8

public FileObservable.Builder utf8()

source

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

tail

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

tailText

public rx.Observable<String> tailText()