edu.stanford.nlp.util.logging

Class RedwoodConfiguration.Handlers

java.lang.Object

edu.stanford.nlp.util.logging.RedwoodConfiguration.Handlers

Enclosing class:

RedwoodConfiguration

public static class RedwoodConfiguration.Handlers
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static LogRecordHandler	collapseApproximate Collapse records in a heuristic way to make reading easier.
static LogRecordHandler	collapseExact Collapse records which are duplicates into a single message, followed by a message detailing how many times it was repeated.
static RedwoodConfiguration.Thunk	defaultFile Output to a file.
static LogRecordHandler	hideDebug Hide the debug channel only.
static LogRecordHandler	hideError Hide the error channel only.
static LogRecordHandler	hideWarn Hide the warning channel only.
static RedwoodConfiguration.Thunk	noop A NOOP, as the name implies.
static RedwoodConfiguration.Thunk	output Output to the default location specified by the output() method.
static LogRecordHandler	showOnlyError Show only errors (e.g., to send them to an error file)
static RedwoodConfiguration.Thunk	stderr Output to a standard error.
static RedwoodConfiguration.Thunk	stdout Output to a standard output.

Constructor Summary

Constructors

Constructor and Description
RedwoodConfiguration.Handlers()

Method Summary

Methods

Modifier and Type	Method and Description
static RedwoodConfiguration.Thunk	branch(RedwoodConfiguration.Thunk... destinations) Send any incoming messages multiple ways.
static RedwoodConfiguration.Thunk	chain(LogRecordHandler[] handlers, RedwoodConfiguration.Thunk destination) Apply each of the handlers to incoming log messages, in sequence.
static RedwoodConfiguration.Thunk	chain(LogRecordHandler handler1, LogRecordHandler handler2, LogRecordHandler handler3, LogRecordHandler handler4, LogRecordHandler handler5, RedwoodConfiguration.Thunk destination)
static RedwoodConfiguration.Thunk	chain(LogRecordHandler handler1, LogRecordHandler handler2, LogRecordHandler handler3, LogRecordHandler handler4, RedwoodConfiguration.Thunk destination)
static RedwoodConfiguration.Thunk	chain(LogRecordHandler handler1, LogRecordHandler handler2, LogRecordHandler handler3, RedwoodConfiguration.Thunk destination)
static RedwoodConfiguration.Thunk	chain(LogRecordHandler handler1, LogRecordHandler handler2, RedwoodConfiguration.Thunk destination)
static RedwoodConfiguration.Thunk	chain(LogRecordHandler handler1, RedwoodConfiguration.Thunk destination)
static RedwoodConfiguration.Thunk	file(File path) Output to a file.
static RedwoodConfiguration.Thunk	file(String path) Output to a file.
static LogRecordHandler	hideChannels(Object... channelsToHide) Hide these channels, in addition to anything already hidden by upstream handlers.
static LogRecordHandler	reroute(Object src, Object dst) Rename a channel to be something else
static LogRecordHandler	showOnlyChannels(Object... channelsToShow) Show only these channels, as far as downstream handlers are concerned.

Methods inherited from class java.lang.Object

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

Field Detail

defaultFile

public static final RedwoodConfiguration.Thunk defaultFile

Output to a file. This is a leaf node. Consider using this instead of specifying a custom path.

stdout

public static final RedwoodConfiguration.Thunk stdout

Output to a standard output. This is a leaf node. Consider using "output" instead, unless you really want to log only to stdout now and forever in the future.

stderr

public static final RedwoodConfiguration.Thunk stderr

Output to a standard error. This is a leaf node. Consider using "output" instead, unless you really want to log only to stderr now and forever in the future.

output

public static final RedwoodConfiguration.Thunk output

Output to the default location specified by the output() method. Consider using this rather than stderr or stdout.

hideDebug

public static final LogRecordHandler hideDebug

Hide the debug channel only.

hideError

public static final LogRecordHandler hideError

Hide the error channel only.

hideWarn

public static final LogRecordHandler hideWarn

Hide the warning channel only.

showOnlyError

public static final LogRecordHandler showOnlyError

Show only errors (e.g., to send them to an error file)

collapseApproximate

public static final LogRecordHandler collapseApproximate

Collapse records in a heuristic way to make reading easier. This is particularly relevant to branches which go to a physical console, or a file which you'd like to keep small.

collapseExact

public static final LogRecordHandler collapseExact

Collapse records which are duplicates into a single message, followed by a message detailing how many times it was repeated.

noop

public static RedwoodConfiguration.Thunk noop

A NOOP, as the name implies. Useful for appending to the end of lists to make commas match.

Constructor Detail

RedwoodConfiguration.Handlers

public RedwoodConfiguration.Handlers()

Method Detail

file

public static RedwoodConfiguration.Thunk file(String path)

Output to a file. This is a leaf node. Consider using "defaultFile" instead.

Parameters:

path - The file to write to

file

public static RedwoodConfiguration.Thunk file(File path)

Output to a file. This is a leaf node. Consider using "defaultFile" instead.

Parameters:

path - The file to write to

hideChannels

public static LogRecordHandler hideChannels(Object... channelsToHide)

Hide these channels, in addition to anything already hidden by upstream handlers.

showOnlyChannels

public static LogRecordHandler showOnlyChannels(Object... channelsToShow)

Show only these channels, as far as downstream handlers are concerned.

reroute

public static LogRecordHandler reroute(Object src,
                       Object dst)

Rename a channel to be something else

branch

public static RedwoodConfiguration.Thunk branch(RedwoodConfiguration.Thunk... destinations)

Send any incoming messages multiple ways. For example, you may want to send the same output to console and a file.

Parameters:

destinations - The destinations for log messages coming into this node.

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler[] handlers,
                               RedwoodConfiguration.Thunk destination)

Apply each of the handlers to incoming log messages, in sequence.

Parameters:

handlers - The handlers to apply

destination - The final destination of the messages, after processing

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler handler1,
                               RedwoodConfiguration.Thunk destination)

See Also:

Handlers#chain(LogRecordHandler[], Thunk)

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler handler1,
                               LogRecordHandler handler2,
                               RedwoodConfiguration.Thunk destination)

See Also:

Handlers#chain(LogRecordHandler[], Thunk)

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler handler1,
                               LogRecordHandler handler2,
                               LogRecordHandler handler3,
                               RedwoodConfiguration.Thunk destination)

See Also:

Handlers#chain(LogRecordHandler[], Thunk)

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler handler1,
                               LogRecordHandler handler2,
                               LogRecordHandler handler3,
                               LogRecordHandler handler4,
                               RedwoodConfiguration.Thunk destination)

See Also:

Handlers#chain(LogRecordHandler[], Thunk)

chain

public static RedwoodConfiguration.Thunk chain(LogRecordHandler handler1,
                               LogRecordHandler handler2,
                               LogRecordHandler handler3,
                               LogRecordHandler handler4,
                               LogRecordHandler handler5,
                               RedwoodConfiguration.Thunk destination)

See Also:

Handlers#chain(LogRecordHandler[], Thunk)