usr.logging

Class Logger

java.lang.Object

usr.logging.Logger

All Implemented Interfaces:

Logging

public class Logger
extends java.lang.Object
implements Logging

An object that will be a logger. It keeps a set of output objects which actually do the logging, and for each one there is a bitmask which determines which log message will be accepted by which output.

This allows us to set up a set of outputs and then configure them at run-time to accept certain log statements. It also allows the same log element to go to multiple log outputs if they have the same bit set in their BitMask.

Constructor Summary

Constructors

Constructor and Description
Logger(java.lang.String name) Construct a Logger object.

Method Summary

Methods

Modifier and Type	Method and Description
Logger	addOutput(java.nio.channels.ByteChannel ch) Add output to a ByteChannel.
Logger	addOutput(java.nio.channels.ByteChannel ch, BitMask mask) Add output to a ByteChannel.
Logger	addOutput(LogOutput eo) Add output to an LogOutput object.
Logger	addOutput(LogOutput eo, BitMask mask) Add output to an LogOutput object.
Logger	addOutput(java.io.PrintStream s) Add output to a printstream.
Logger	addOutput(java.io.PrintStream s, BitMask mask) Add output to a printstream.
Logger	addOutput(java.io.PrintWriter w) Add output to a printwriter
Logger	addOutput(java.io.PrintWriter w, BitMask mask) Add output to a printwriter
static Logger	getLogger(java.lang.String name) A static method that returns a Logger by name.
BitMask	getMaskForOutput(java.lang.Object output) Get a mask for a an output object.
void	log(BitMask mask, LogInput obj) Log using a LogInput object.
void	log(BitMask mask, java.lang.String msg) Log a message using a Strng.
void	log(int mask, LogInput obj) Log using a LogInput object.
void	log(int mask, java.lang.String msg) Log a message using a Strng.
void	logln(BitMask mask, java.lang.String msg) Log a message using a Strng.
void	logln(int mask, java.lang.String msg) Log a message using a Strng.
Logger	removeOutput(LogOutput eo) Remove output to an LogOutput object.
Logger	removeOutput(java.io.PrintStream s) Remove output to a printstream.
Logger	removeOutput(java.io.PrintWriter w) Remove output to a printwriter
Logger	setMaskForOutput(java.lang.Object output, BitMask mask) Set a mask for a an output object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(java.lang.String name)

Construct a Logger object.

Method Detail

getLogger

public static Logger getLogger(java.lang.String name)

A static method that returns a Logger by name. If the Logger with that name already exists it is returned, otherwise it is created first.

log

public void log(BitMask mask,
       java.lang.String msg)

Log a message using a Strng.

Specified by:

log in interface Logging

logln

public void logln(BitMask mask,
         java.lang.String msg)

Log a message using a Strng. Add a trailing newline.

Specified by:

logln in interface Logging

log

public void log(BitMask mask,
       LogInput obj)

Log using a LogInput object.

Specified by:

log in interface Logging

log

public void log(int mask,
       java.lang.String msg)

Log a message using a Strng.

logln

public void logln(int mask,
         java.lang.String msg)

Log a message using a Strng. Add a trailing newline.

log

public void log(int mask,
       LogInput obj)

Log using a LogInput object.

addOutput

public Logger addOutput(java.io.PrintWriter w)

Add output to a printwriter

Specified by:

addOutput in interface Logging

addOutput

public Logger addOutput(java.io.PrintStream s)

Add output to a printstream.

Specified by:

addOutput in interface Logging

addOutput

public Logger addOutput(java.nio.channels.ByteChannel ch)

Add output to a ByteChannel.

Specified by:

addOutput in interface Logging

addOutput

public Logger addOutput(LogOutput eo)

Add output to an LogOutput object.

Specified by:

addOutput in interface Logging

addOutput

public Logger addOutput(java.io.PrintWriter w,
               BitMask mask)

Add output to a printwriter

addOutput

public Logger addOutput(java.io.PrintStream s,
               BitMask mask)

Add output to a printstream.

addOutput

public Logger addOutput(java.nio.channels.ByteChannel ch,
               BitMask mask)

Add output to a ByteChannel.

addOutput

public Logger addOutput(LogOutput eo,
               BitMask mask)

Add output to an LogOutput object.

removeOutput

public Logger removeOutput(java.io.PrintWriter w)

Remove output to a printwriter

removeOutput

public Logger removeOutput(java.io.PrintStream s)

Remove output to a printstream.

removeOutput

public Logger removeOutput(LogOutput eo)

Remove output to an LogOutput object.

getMaskForOutput

public BitMask getMaskForOutput(java.lang.Object output)

Get a mask for a an output object.

setMaskForOutput

public Logger setMaskForOutput(java.lang.Object output,
                      BitMask mask)

Set a mask for a an output object.