LogWatchBuilder (splitlog: watching your logs 1.7.2 API)

java.lang.Object
- com.github.triceo.splitlog.api.LogWatchBuilder

Direct Known Subclasses:

DefaultLogWatchBuilder
```
public abstract class LogWatchBuilder
extends Object
```
Prepares an instance of LogWatch that will automatically LogWatch.start(). Unless overriden by the user, the instance will have the following properties:

Reads file from beginning?

Yes.

Closes file when the reading is finished?

No.

The default interval between each read

See DEFAULT_DELAY_BETWEEN_READS_IN_MILLISECONDS.

The buffer size for reading

See DEFAULT_READ_BUFFER_SIZE_IN_BYTES.

Default message capacity

Integer.MAX_VALUE, the maximum possible.

Interval between two sweeps for unreachable messages.

See DEFAULT_DELAY_BETWEEN_SWEEPS_IN_MILLISECONDS.

Interval between requesting tailing and the actual start of tailing.

By default, the instance will store (and notify of) every message that has passed the getGateCondition() and not do so for all others.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_DELAY_BETWEEN_READS_IN_MILLISECONDS`
`static long`	`DEFAULT_DELAY_BETWEEN_SWEEPS_IN_MILLISECONDS`
`static int`	`DEFAULT_READ_BUFFER_SIZE_IN_BYTES`

Constructor Summary

Constructors
Constructor and Description

LogWatchBuilder()

Constructors
Constructor and Description
`LogWatchBuilder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract LogWatch`	`build()` Build the log watch with previously defined properties, or defaults where not overriden.
`abstract Follower`	`buildFollowing()` Build the log watch with previously defined properties, or defaults where not overriden, and immediately start listening for `Message`s.
`abstract Follower`	`buildFollowingWith(TailSplitter splitter)` Build the log watch with previously defined properties, or defaults where not overriden, and immediately start listening for `Message`s
`abstract LogWatch`	`buildWith(TailSplitter splitter)` Build the log watch with previously defined properties, or defaults where not overriden.
`LogWatchBuilder`	`closingAfterReading()` Change the default behavior of the future log watch to close the watched file after each reading.
`LogWatchBuilder`	`doNotStart()` Do not run `LogWatch.start()` on the new instance.
`int`	`getCapacityLimit()` Get the capacity of the future log watch.
`static LogWatchBuilder`	`getDefault()` Used to construct a `LogWatch` for a particular log file.
`long`	`getDelayBetweenReads()` Get the delay between attempts to read from the watched file.
`long`	`getDelayBetweenSweeps()` Get the delay between attempts to sweep unreachable messages from memory.
`File`	`getFileToWatch()` Get the file that the log watch will be watching.
`SimpleMessageCondition`	`getGateCondition()` The condition that will be used for accepting a `Message` into `LogWatch`.
`int`	`getReadingBufferSize()` Get the buffer size for the log watch.
`SimpleMessageCondition`	`getStorageCondition()` The condition that will be used for storing a `Message` within `LogWatch`.
`LogWatchBuilder`	`ignoringPreexistingContent()` Change the default behavior of the future log watch so that the existing contents of the file is ignored and only the future additions to the file are reported.
`boolean`	`isClosingBetweenReads()`
`boolean`	`isReadingFromBeginning()`
`LogWatchBuilder`	`limitCapacityTo(int size)` Limit capacity of the log watch to a given amount of messages.
`String`	`toString()`
`LogWatchBuilder`	`watchedFile(File f)` Set the file that the future `LogWatch` will be tailing.
`boolean`	`willBeStarted()`
`LogWatchBuilder`	`withDelayBetweenReads(int length, TimeUnit unit)` Specify the delay between attempts to read the file.
`LogWatchBuilder`	`withDelayBetweenSweeps(int length, TimeUnit unit)` Specify the delay between attempts to sweep the log watch from unreachable messages.
`LogWatchBuilder`	`withGateCondition(SimpleMessageCondition condition)` Only the `Message`s for which `SimpleMessageCondition.accept(Message)` is true will be passed to `Follower`s and other `MessageConsumer`s.
`LogWatchBuilder`	`withReadingBufferSize(int bufferSize)` Specify the buffer size that will be used for reading changes made to the watched file.
`LogWatchBuilder`	`withStorageCondition(SimpleMessageCondition condition)` Only the messages for which `SimpleMessageCondition.accept(Message)` is true will be stored within the future `LogWatch`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_DELAY_BETWEEN_READS_IN_MILLISECONDS
```
public static final long DEFAULT_DELAY_BETWEEN_READS_IN_MILLISECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DELAY_BETWEEN_SWEEPS_IN_MILLISECONDS
```
public static final long DEFAULT_DELAY_BETWEEN_SWEEPS_IN_MILLISECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_BUFFER_SIZE_IN_BYTES
```
public static final int DEFAULT_READ_BUFFER_SIZE_IN_BYTES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogWatchBuilder
```
public LogWatchBuilder()
```
- Method Detail
  - getDefault
```
public static LogWatchBuilder getDefault()
```
    Used to construct a LogWatch for a particular log file.
    
    Returns:
    
    Builder that is used to configure the new log watch instance before using.
  - build
```
public abstract LogWatch build()
```
    Build the log watch with previously defined properties, or defaults where not overriden. Such log watch will not start actually reading getFileToWatch() until after LogWatch.startFollowing() or MessageProducer.startConsuming(com.github.triceo.splitlog.api.MessageListener) .
    
    Returns:
    
    The newly built log watch.
  - buildFollowing
```
public abstract Follower buildFollowing()
```
    Build the log watch with previously defined properties, or defaults where not overriden, and immediately start listening for Messages.
    
    Returns:
    
    The follower that will receive the initial messages. The actual LogWatch can be retrieved by Follower.getFollowed().
  - buildFollowingWith
```
public abstract Follower buildFollowingWith(TailSplitter splitter)
```
    Build the log watch with previously defined properties, or defaults where not overriden, and immediately start listening for Messages
    
    Parameters:
    
    splitter - The splitter instance to use for the log watch instead of the default.
    
    Returns:
    
    The follower that will receive the initial messages. The actual LogWatch can be retrieved by Follower.getFollowed().
  - buildWith
```
public abstract LogWatch buildWith(TailSplitter splitter)
```
    Build the log watch with previously defined properties, or defaults where not overriden. Such log watch will not start actually reading getFileToWatch() until after LogWatch.startFollowing() or MessageProducer.startConsuming(com.github.triceo.splitlog.api.MessageListener) .
    
    Parameters:
    
    splitter - The splitter instance to use for the log watch instead of the default.
    
    Returns:
    
    The newly built log watch. This log watch will not start tailing until after LogWatch.startFollowing() or MessageProducer.startConsuming(com.github.triceo.splitlog.api.MessageListener) .
  - closingAfterReading
```
public LogWatchBuilder closingAfterReading()
```
    Change the default behavior of the future log watch to close the watched file after each reading.
    
    Returns:
    
    This.
  - doNotStart
```
public LogWatchBuilder doNotStart()
```
    Do not run LogWatch.start() on the new instance.
    
    Returns:
    
    This.
  - getCapacityLimit
```
public int getCapacityLimit()
```
    Get the capacity of the future log watch.
    
    Returns:
    
    Maximum capacity in messages.
  - getDelayBetweenReads
```
public long getDelayBetweenReads()
```
    Get the delay between attempts to read from the watched file.
    
    Returns:
    
    In milliseconds.
  - getDelayBetweenSweeps
```
public long getDelayBetweenSweeps()
```
    Get the delay between attempts to sweep unreachable messages from memory.
    
    Returns:
    
    In milliseconds.
  - getFileToWatch
```
public File getFileToWatch()
```
    Get the file that the log watch will be watching.
    
    Returns:
    
    The file that will be watched by the future log watch.
  - getGateCondition
```
public SimpleMessageCondition getGateCondition()
```
    The condition that will be used for accepting a Message into LogWatch.
    
    Returns:
    
    The condition.
  - getReadingBufferSize
```
public int getReadingBufferSize()
```
    Get the buffer size for the log watch.
    
    Returns:
    
    In bytes.
  - getStorageCondition
```
public SimpleMessageCondition getStorageCondition()
```
    The condition that will be used for storing a Message within LogWatch.
    
    Returns:
    
    The condition.
  - ignoringPreexistingContent
```
public LogWatchBuilder ignoringPreexistingContent()
```
    Change the default behavior of the future log watch so that the existing contents of the file is ignored and only the future additions to the file are reported.
    
    Returns:
    
    This.
  - isClosingBetweenReads
```
public boolean isClosingBetweenReads()
```
    Returns:
    
    Whether or not the file will be closed after it is read from.
  - isReadingFromBeginning
```
public boolean isReadingFromBeginning()
```
    Returns:
    
    True if the file will be read from the beginning, false if just the additions made post starting the log watch.
  - limitCapacityTo
```
public LogWatchBuilder limitCapacityTo(int size)
```
    Limit capacity of the log watch to a given amount of messages.
    
    Parameters:
    
    size - Maximum amount of messages to store.
    
    Returns:
    
    This.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - watchedFile
```
public LogWatchBuilder watchedFile(File f)
```
    Set the file that the future LogWatch will be tailing.
    
    Parameters:
    
    f - File to watch.
    
    Returns:
    
    This.
  - willBeStarted
```
public boolean willBeStarted()
```
    Returns:
    
    True if the new logwatch will already be LogWatch.start()ed.
  - withDelayBetweenReads
```
public LogWatchBuilder withDelayBetweenReads(int length,
                                             TimeUnit unit)
```
    Specify the delay between attempts to read the file.
    
    Parameters:
    
    length - Length of time.
    
    unit - Unit of that length.
    
    Returns:
    
    This.
  - withDelayBetweenSweeps
```
public LogWatchBuilder withDelayBetweenSweeps(int length,
                                              TimeUnit unit)
```
    Specify the delay between attempts to sweep the log watch from unreachable messages.
    
    Parameters:
    
    length - Length of time.
    
    unit - Unit of that length.
    
    Returns:
    
    This.
  - withGateCondition
```
public LogWatchBuilder withGateCondition(SimpleMessageCondition condition)
```
    Only the Messages for which SimpleMessageCondition.accept(Message) is true will be passed to Followers and other MessageConsumers. Such Messages will also never be stored. For the purposes of Splitlog, if it fails this condition, it's as if it never existed.
    
    Parameters:
    
    condition - The condition.
    
    Returns:
    
    This.
  - withReadingBufferSize
```
public LogWatchBuilder withReadingBufferSize(int bufferSize)
```
    Specify the buffer size that will be used for reading changes made to the watched file.
    
    Parameters:
    
    bufferSize - In bytes.
    
    Returns:
    
    This.
  - withStorageCondition
```
public LogWatchBuilder withStorageCondition(SimpleMessageCondition condition)
```
    Only the messages for which SimpleMessageCondition.accept(Message) is true will be stored within the future LogWatch. However, MessageConsumers will be notified of them either way. The condition in question will only ever be called on Messages that have already passed the getGateCondition().
    
    Parameters:
    
    condition - The condition.
    
    Returns:
    
    This.

Class LogWatchBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DELAY_BETWEEN_READS_IN_MILLISECONDS

DEFAULT_DELAY_BETWEEN_SWEEPS_IN_MILLISECONDS

DEFAULT_READ_BUFFER_SIZE_IN_BYTES

Constructor Detail

LogWatchBuilder

Method Detail

getDefault

build

buildFollowing

buildFollowingWith

buildWith

closingAfterReading

doNotStart

getCapacityLimit

getDelayBetweenReads

getDelayBetweenSweeps

getFileToWatch

getGateCondition

getReadingBufferSize

getStorageCondition

ignoringPreexistingContent

isClosingBetweenReads

isReadingFromBeginning

limitCapacityTo

toString

watchedFile

willBeStarted

withDelayBetweenReads

withDelayBetweenSweeps

withGateCondition

withReadingBufferSize

withStorageCondition