edu.stanford.nlp.util.logging

Class RedwoodConfiguration

java.lang.Object

edu.stanford.nlp.util.logging.RedwoodConfiguration

Direct Known Subclasses:

StanfordRedwoodConfiguration

public class RedwoodConfiguration
extends Object

A class which encapsulates configuration settings for Redwood. The class operates on the builder model; that is, you can chain method calls.

Author:

Gabor Angeli (angeli at cs.stanford)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedwoodConfiguration.Handlers
static interface	RedwoodConfiguration.Thunk

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedwoodConfiguration() Private constructor to prevent use of "new RedwoodConfiguration()"

Method Summary

Modifier and Type	Method and Description
void	apply() Apply this configuration to Redwood
static void	apply(Properties props) Parses a properties file and applies it immediately to Redwood
RedwoodConfiguration	capture(OutputStream stream) Capture a system stream
RedwoodConfiguration	channelWidth(int width) Set the width of the channels (or 0 to not show channels)
RedwoodConfiguration	clear() Clear any custom configurations to Redwood
static RedwoodConfiguration	current() The current Redwood configuration; this is used to make incremental changes to an existing custom configuration.
static RedwoodConfiguration	empty() An empty Redwood configuration.
RedwoodConfiguration	handlers(RedwoodConfiguration.Thunk... paths)
RedwoodConfiguration	neatExit() Close tracks when the JVM shuts down.
RedwoodConfiguration	output(String method) Determine where, in the end, console output should go.
static RedwoodConfiguration	parse(Properties props) Configure Redwood (from scratch) based on a Properties file.
RedwoodConfiguration	restore(OutputStream stream)
static RedwoodConfiguration	standard() The default Redwood configuration, which prints to the console.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedwoodConfiguration

protected RedwoodConfiguration()

Private constructor to prevent use of "new RedwoodConfiguration()"

Method Detail

apply

public void apply()

Apply this configuration to Redwood

capture

public RedwoodConfiguration capture(OutputStream stream)

Capture a system stream

Parameters:

stream - The stream to capture; one of System.out or System.err

Returns:

this

restore

public RedwoodConfiguration restore(OutputStream stream)

output

public RedwoodConfiguration output(String method)

Determine where, in the end, console output should go. The default is stdout.

Parameters:

method - An output, one of: stdout, stderr, or java.util.logging

Returns:

this

channelWidth

public RedwoodConfiguration channelWidth(int width)

Set the width of the channels (or 0 to not show channels)

Parameters:

width - The left margin in which to show channels

Returns:

this

clear

public RedwoodConfiguration clear()

Clear any custom configurations to Redwood

Returns:

this

handlers

public RedwoodConfiguration handlers(RedwoodConfiguration.Thunk... paths)

For example:

   handlers(branch(
     chain( hideDebug, collapseApproximate, branch( output, file("stderr.log") ),
     chain( showOnlyError, file("err.log") ).
     chain( showOnlyChannels("results", "evaluate"), file("results.log") ),
     chain( file("redwood.log") ),
   noop))
 

Parameters:

paths - A number of paths to add.

Returns:

this

neatExit

public RedwoodConfiguration neatExit()

Close tracks when the JVM shuts down.

Returns:

this

empty

public static RedwoodConfiguration empty()

An empty Redwood configuration. Note that without a Console Handler, Redwood will not print anything

Returns:

An empty Redwood Configuration object.

standard

public static RedwoodConfiguration standard()

The default Redwood configuration, which prints to the console. This is the usual starting point for new configurations.

Returns:

A basic Redwood Configuration.

current

public static RedwoodConfiguration current()

The current Redwood configuration; this is used to make incremental changes to an existing custom configuration.

Returns:

The current Redwood configuration.

parse

public static RedwoodConfiguration parse(Properties props)

Configure Redwood (from scratch) based on a Properties file. Currently recognized properties are:

• log.captureStreams = {true,false}: Capture stdout and stderr and route them through Redwood
• log.captureStdout = {true,false}: Capture stdout and route it through Redwood
• log.captureStderr = {true,false}: Capture stdout and route it through Redwood
• log.channels.width = {number}: Show the channels being logged to, at this width (default: 0; recommended: 20)
• log.channels.debug = {true,false}: Show the debugging channel
• log.file = By default, write to this file.
• log.neatExit = {true,false}: Clean up logs on exception or regular system exit
• log.output = {stderr,stdout,java.util.logging}: Output messages to either stderr or stdout by default.

Parameters:

props - The properties to use in configuration

Returns:

A new Redwood Configuration based on the passed properties, ignoring any existing custom configuration

apply

public static void apply(Properties props)

Parses a properties file and applies it immediately to Redwood

Parameters:

props - The properties to apply