org.jcoderz.commons.logging
Class DisplayOptions

java.lang.Object
  org.jcoderz.commons.logging.DisplayOptions

All Implemented Interfaces:

Cloneable

public final class DisplayOptions
extends Object
implements Cloneable

This class comprises display options, i.e. which fields are to display with how many details.

Constructor Summary

DisplayOptions()

Method Summary

Object	clone()
boolean	displayBusinessImpact() Gets the flag whether the business impact is displayed.
void	displayBusinessImpact(boolean display) Sets the flag whether the business impact is displayed.
boolean	displayCategory() Gets the flag whether the category is displayed.
void	displayCategory(boolean display) Sets the flag whether the category is displayed.
boolean	displayInstanceId() Gets the flag whether the instance id is displayed.
void	displayInstanceId(boolean display) Sets the flag whether the instance id is displayed.
boolean	displayLoggerLevel() Gets the flag whether the logger level is displayed.
void	displayLoggerLevel(boolean display) Sets the flag whether the logger level / severity is displayed.
boolean	displayMessageStackTrace() Gets the flag whether a log message's stacktrace is displayed.
void	displayMessageStackTrace(boolean display) Sets the flag whether the stack trace of a log message is displayed.
boolean	displayNodeId() Gets the flag whether the node id is displayed.
void	displayNodeId(boolean display) Sets the flag whether the node id is displayed.
boolean	displayParameters() Gets the flag whether the parameters are displayed.
void	displayParameters(boolean display) Sets the flag whether the parameters for a message are displayed.
boolean	displayRecordNumber() Gets the flag whether the record number is displayed.
void	displayRecordNumber(boolean display) Sets the flag whether the record number of a log file record is displayed.
boolean	displaySolution() Gets the flag whether the possible solution is displayed.
void	displaySolution(boolean display) Sets the flag whether the possible solution for a message is displayed.
boolean	displaySourceClass() Gets the flag whether the source class name is displayed.
void	displaySourceClass(boolean display) Sets the flag whether the source class, where the message was logged, is displayed.
boolean	displaySourceMethod() Gets the flag whether the source method name is displayed.
void	displaySourceMethod(boolean display) Sets the flag whether the source method, where the message was logged, is displayed.
boolean	displayStackTrace() Gets the flag whether an exception's stacktrace is displayed.
void	displayStackTrace(boolean display) Sets the flag whether the stack trace of an exception is displayed.
boolean	displaySymbol() Gets the flag whether the symbol is displayed.
void	displaySymbol(boolean display) Sets the flag whether the symbol is displayed.
boolean	displaySymbolId() Gets the flag whether the symbol id is displayed.
void	displaySymbolId(boolean display) Sets the flag whether the symbol id is displayed.
boolean	displayThreadId() Gets the flag whether the thread id is displayed.
void	displayThreadId(boolean display) Sets the flag whether the thread id is displayed.
boolean	displayThreadName() Sets the flag whether the thread name should be displayed.
void	displayThreadName(boolean display) Sets the flag whether the thread name is displayed.
boolean	displayTimestamp() Gets the flag whether the timestamp is displayed.
void	displayTimestamp(boolean display) Sets the flag whether the timestamp is displayed.
boolean	displayTraceLines() Gets the flag whether standard trace logs are displayed, i.e. undeclared log messages, which are generated by standard logger api calls.
void	displayTraceLines(boolean display) Sets the flag whether standard trace logs are displayed, i.e. undeclared log messages, which are generated by standard logger api calls.
boolean	displayTrackingNumber() Gets the flag whether the sequence of tracking numbers is displayed.
void	displayTrackingNumber(boolean display) Sets the flag whether the sequence of tracking numbers is displayed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayOptions

public DisplayOptions()

Method Detail

displayThreadId

public void displayThreadId(boolean display)

Sets the flag whether the thread id is displayed.

Parameters:

display - If true, thread id is displayed; if false do not display the thread id.

displayThreadId

public boolean displayThreadId()

Gets the flag whether the thread id is displayed.

Returns:

true if the thread id is to display; false, else.

displayNodeId

public void displayNodeId(boolean display)

Sets the flag whether the node id is displayed.

Parameters:

display - If true, node id is displayed; if false do not display the node id.

displayNodeId

public boolean displayNodeId()

Gets the flag whether the node id is displayed.

Returns:

true if the node id is to display; false, else.

displayInstanceId

public void displayInstanceId(boolean display)

Sets the flag whether the instance id is displayed.

Parameters:

display - If true, instance id is displayed; if false do not display the instance id.

displayInstanceId

public boolean displayInstanceId()

Gets the flag whether the instance id is displayed.

Returns:

true if the instance id is to display; false, else.

displayBusinessImpact

public void displayBusinessImpact(boolean display)

Sets the flag whether the business impact is displayed.

Parameters:

display - If true, business impact is displayed; if false do not display the business impact.

displayBusinessImpact

public boolean displayBusinessImpact()

Gets the flag whether the business impact is displayed.

Returns:

true if the business impact is to display; false, else.

displayCategory

public void displayCategory(boolean display)

Sets the flag whether the category is displayed.

Parameters:

display - If true, category is displayed; if false do not display the category.

displayCategory

public boolean displayCategory()

Gets the flag whether the category is displayed.

Returns:

true if the category is to display; false, else.

displayThreadName

public void displayThreadName(boolean display)

Sets the flag whether the thread name is displayed.

Parameters:

display - If true, the thread name is displayed; if false do not display the thread name.

displayThreadName

public boolean displayThreadName()

Sets the flag whether the thread name should be displayed.

Returns:

true, the thread name is displayed; if false do not display the thread name.

displayLoggerLevel

public void displayLoggerLevel(boolean display)

Sets the flag whether the logger level / severity is displayed.

Parameters:

display - If true, logger level is displayed; if false do not display the logger level.

displayLoggerLevel

public boolean displayLoggerLevel()

Gets the flag whether the logger level is displayed.

Returns:

true if the logger level is to display; false, else.

displayTimestamp

public void displayTimestamp(boolean display)

Sets the flag whether the timestamp is displayed.

Parameters:

display - If true, timestamp is displayed; if false do not display the timestamp.

displayTimestamp

public boolean displayTimestamp()

Gets the flag whether the timestamp is displayed.

Returns:

true if the timestamp is to display; false, else.

displayRecordNumber

public void displayRecordNumber(boolean display)

Sets the flag whether the record number of a log file record is displayed.

Parameters:

display - If true, record number is displayed; if false do not display the record number.

displayRecordNumber

public boolean displayRecordNumber()

Gets the flag whether the record number is displayed.

Returns:

true if the record number is to display; false, else.

displaySourceClass

public void displaySourceClass(boolean display)

Sets the flag whether the source class, where the message was logged, is displayed.

Parameters:

display - If true, source class is displayed; if false do not display the source class.

displaySourceClass

public boolean displaySourceClass()

Gets the flag whether the source class name is displayed.

Returns:

true if the source class name is to display; false, else.

displaySourceMethod

public void displaySourceMethod(boolean display)

Sets the flag whether the source method, where the message was logged, is displayed.

Parameters:

display - If true, source method is displayed; if false do not display the source method.

displaySourceMethod

public boolean displaySourceMethod()

Gets the flag whether the source method name is displayed.

Returns:

true if the source method name is to display; false, else.

displaySolution

public void displaySolution(boolean display)

Sets the flag whether the possible solution for a message is displayed.

Parameters:

display - If true, solution is displayed; if false do not display the solution.

displaySolution

public boolean displaySolution()

Gets the flag whether the possible solution is displayed.

Returns:

true if the solution is to display; false, else.

displayParameters

public void displayParameters(boolean display)

Sets the flag whether the parameters for a message are displayed.

Parameters:

display - If true, parameters are displayed; if false do not display the parameters.

displayParameters

public boolean displayParameters()

Gets the flag whether the parameters are displayed.

Returns:

true if the parameters are to display; false, else.

displaySymbol

public void displaySymbol(boolean display)

Sets the flag whether the symbol is displayed.

Parameters:

display - If true, the symbol is displayed; if false do not display the symbol.

displaySymbol

public boolean displaySymbol()

Gets the flag whether the symbol is displayed.

Returns:

true if the symbol is to display; false, else.

displaySymbolId

public void displaySymbolId(boolean display)

Sets the flag whether the symbol id is displayed.

Parameters:

display - If true, the symbol id is displayed; if false do not display the symbol id.

displaySymbolId

public boolean displaySymbolId()

Gets the flag whether the symbol id is displayed.

Returns:

true if the symbol id is to display; false, else.

displayTrackingNumber

public void displayTrackingNumber(boolean display)

Sets the flag whether the sequence of tracking numbers is displayed.

Parameters:

display - If true, the sequence of tracking numbers is displayed; if false do not display the sequence of tracking numbers.

displayTrackingNumber

public boolean displayTrackingNumber()

Gets the flag whether the sequence of tracking numbers is displayed.

Returns:

true if the sequence of tracking numbers is to display; false, else.

displayStackTrace

public void displayStackTrace(boolean display)

Sets the flag whether the stack trace of an exception is displayed.

Parameters:

display - If true, the stacktrace of an exception is displayed; if false do not display an exception's stacktrace.

displayStackTrace

public boolean displayStackTrace()

Gets the flag whether an exception's stacktrace is displayed.

Returns:

true if the stacktrace of an exception is to display; false, else.

displayMessageStackTrace

public void displayMessageStackTrace(boolean display)

Sets the flag whether the stack trace of a log message is displayed.

Parameters:

display - If true, the stacktrace of a log message is displayed; if false do not display a log message's stacktrace.

displayMessageStackTrace

public boolean displayMessageStackTrace()

Gets the flag whether a log message's stacktrace is displayed.

Returns:

true if the stacktrace of an log message is to display; false, else.

displayTraceLines

public void displayTraceLines(boolean display)

Sets the flag whether standard trace logs are displayed, i.e. undeclared log messages, which are generated by standard logger api calls.

Parameters:

display - If true, standard trace logs are displayed; if false do not display standard trace logs.

displayTraceLines

public boolean displayTraceLines()

Gets the flag whether standard trace logs are displayed, i.e. undeclared log messages, which are generated by standard logger api calls.

Returns:

true if trace logs are to display; false, else.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException