org.lexevs.logging.messaging.impl
Class CommandLineMessageDirector

java.lang.Object
  extended by org.lexevs.logging.messaging.impl.CommandLineMessageDirector
All Implemented Interfaces:
LgMessageDirectorIF

public class CommandLineMessageDirector
extends java.lang.Object
implements LgMessageDirectorIF

An implementation of the LgMessageDirectorIF that routes the messages to the command line. Also prints messages to a log4j logger (if one is provided)

Author:
Dan Armbrust

Constructor Summary
CommandLineMessageDirector()
          Instantiates a new command line message director.
CommandLineMessageDirector(java.lang.String logName)
          Construct a command line message director that will also write to a log4j logger of the given name.
CommandLineMessageDirector(java.lang.String logName, boolean showDebug)
          Construct a command line message director that will also write to a log4j logger of the given name.
 
Method Summary
 void busy()
          Output to indicate system is busy.
 java.lang.String debug(java.lang.String message)
          Take a debug message.
 java.lang.String error(java.lang.String message)
          Display a non-fatal error to the user.
 java.lang.String error(java.lang.String message, java.lang.Throwable sourceException)
          Display a non-fatal error to the user
 java.lang.String fatal(java.lang.String message)
          Display a fatal error to the user.
 java.lang.String fatal(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user.
 void fatalAndThrowException(java.lang.String message)
          Display a fatal error to the user - and then throw an exception.
 void fatalAndThrowException(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user - and then throw an exception.
 java.lang.String info(java.lang.String message)
          Displays a status type of message (not an error or a warning)
 java.lang.String warn(java.lang.String message)
          Display a warning to the user.
 java.lang.String warn(java.lang.String message, java.lang.Throwable sourceException)
          Display a warning to the user
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommandLineMessageDirector

public CommandLineMessageDirector(java.lang.String logName,
                                  boolean showDebug)
Construct a command line message director that will also write to a log4j logger of the given name.

Parameters:
logName - the log name
showDebug - should debug messages be printed to the screen.

CommandLineMessageDirector

public CommandLineMessageDirector(java.lang.String logName)
Construct a command line message director that will also write to a log4j logger of the given name.

Parameters:
logName - the log name

CommandLineMessageDirector

public CommandLineMessageDirector()
Instantiates a new command line message director.

Method Detail

busy

public void busy()
Output to indicate system is busy.

Specified by:
busy in interface LgMessageDirectorIF

error

public java.lang.String error(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a non-fatal error to the user.

Specified by:
error in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

error

public java.lang.String error(java.lang.String message,
                              java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a non-fatal error to the user

Specified by:
error in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.

fatal

public java.lang.String fatal(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user.

Specified by:
fatal in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

fatal

public java.lang.String fatal(java.lang.String message,
                              java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user.

Specified by:
fatal in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.
Returns:
Implementations may return a string, such as a log id.

fatalAndThrowException

public void fatalAndThrowException(java.lang.String message)
                            throws java.lang.Exception
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user - and then throw an exception.

Specified by:
fatalAndThrowException in interface LgMessageDirectorIF
Throws:
java.lang.Exception

fatalAndThrowException

public void fatalAndThrowException(java.lang.String message,
                                   java.lang.Throwable sourceException)
                            throws java.lang.Exception
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user - and then throw an exception.

Specified by:
fatalAndThrowException in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.
Throws:
java.lang.Exception

info

public java.lang.String info(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Displays a status type of message (not an error or a warning)

Specified by:
info in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

warn

public java.lang.String warn(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a warning to the user.

Specified by:
warn in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

warn

public java.lang.String warn(java.lang.String message,
                             java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a warning to the user

Specified by:
warn in interface LgMessageDirectorIF
sourceException - The source exception that caused the warning
Returns:
Implementations may return a string, such as a log id.

debug

public java.lang.String debug(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Take a debug message.

Specified by:
debug in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.