public class MessageDirector extends java.lang.Object implements LgMessageDirectorIF, java.io.Serializable
Modifier and Type | Field and Description |
---|---|
protected int |
count_ |
protected java.util.List<LogEntry> |
messages_ |
protected java.lang.String |
programName_ |
protected ProcessStatus |
status_ |
Constructor and Description |
---|
MessageDirector(java.lang.String programName,
ProcessStatus status) |
Modifier and Type | Method and Description |
---|---|
void |
busy()
Output to indicate system is busy - spin a cursor, print a dot, etc.
|
void |
clearMessages() |
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.
|
LogEntry[] |
getLogEntries(LogLevel level) |
protected LgLoggerIF |
getLogger() |
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
|
protected java.util.List<LogEntry> messages_
protected int count_
protected java.lang.String programName_
protected ProcessStatus status_
public MessageDirector(java.lang.String programName, ProcessStatus status)
protected LgLoggerIF getLogger()
public void busy()
LgMessageDirectorIF
busy
in interface LgMessageDirectorIF
public void clearMessages()
public java.lang.String error(java.lang.String message)
LgMessageDirectorIF
error
in interface LgMessageDirectorIF
public java.lang.String error(java.lang.String message, java.lang.Throwable sourceException)
LgMessageDirectorIF
error
in interface LgMessageDirectorIF
sourceException
- The source exception that caused the error.public java.lang.String fatal(java.lang.String message)
LgMessageDirectorIF
fatal
in interface LgMessageDirectorIF
public java.lang.String fatal(java.lang.String message, java.lang.Throwable sourceException)
LgMessageDirectorIF
fatal
in interface LgMessageDirectorIF
sourceException
- The source exception that caused the error.public void fatalAndThrowException(java.lang.String message) throws java.lang.Exception
LgMessageDirectorIF
fatalAndThrowException
in interface LgMessageDirectorIF
java.lang.Exception
public void fatalAndThrowException(java.lang.String message, java.lang.Throwable sourceException) throws java.lang.Exception
LgMessageDirectorIF
fatalAndThrowException
in interface LgMessageDirectorIF
sourceException
- The source exception that caused the error.java.lang.Exception
public java.lang.String info(java.lang.String message)
LgMessageDirectorIF
info
in interface LgMessageDirectorIF
public java.lang.String warn(java.lang.String message)
LgMessageDirectorIF
warn
in interface LgMessageDirectorIF
public java.lang.String warn(java.lang.String message, java.lang.Throwable sourceException)
LgMessageDirectorIF
warn
in interface LgMessageDirectorIF
sourceException
- The source exception that caused the warningpublic java.lang.String debug(java.lang.String message)
LgMessageDirectorIF
debug
in interface LgMessageDirectorIF