com.isti.util.logging
Interface IstiLogger

All Known Implementing Classes:
AbstractIstiLogger, IstiConsoleLogger, LogFile

public interface IstiLogger

Interface IstiLogger defines an ISTI logger.


Field Summary
static int ALL_MSGS
          A message level value used to specify that all messages will be retained (-999).
static java.lang.String ALL_MSGS_STR
          String version of a message level value used to specify that all messages will be retained.
static int DEBUG
          A message level value that denotes a debug message, for developers only (0).
static java.lang.String DEBUG_STR
          String version of a message level value that denotes a debug message, for developers only.
static int DEBUG2
          A message level value that denotes a lower-level debug (2) message, for developers only (-1).
static java.lang.String DEBUG2_STR
          String version of a message level value that denotes a debug (2) message, for developers only.
static int DEBUG3
          A message level value that denotes a lower-level debug (3) message, for developers only (-2).
static java.lang.String DEBUG3_STR
          String version of a message level value that denotes a debug (3) message, for developers only.
static int DEBUG4
          A message level value that denotes a lower-level debug (4) message, for developers only (-3).
static java.lang.String DEBUG4_STR
          String version of a message level value that denotes a debug (4) message, for developers only.
static int DEBUG5
          A message level value that denotes a lower-level debug (5) message, for developers only (-4).
static java.lang.String DEBUG5_STR
          String version of a message level value that denotes a debug (5) message, for developers only.
static int ERROR
          A message level value that denotes an error which causes the program to abort (3).
static java.lang.String ERROR_STR
          String version of a message level value that denotes an error which causes the program to abort.
static int INFO
          A message level value that denotes an informational message (1).
static java.lang.String INFO_STR
          String version of a message level value that denotes an informational message.
static int NO_MSGS
          A message level value used to specify that no messages will be retained (999).
static java.lang.String NO_MSGS_STR
          String version of a message level value used to specify that no messages will be retained.
static int WARNING
          A message level value that denotes an unexpected condition, but the program continues (2).
static java.lang.String WARNING_STR
          String version of a message level value that denotes an unexpected condition, but the program continues.
 
Method Summary
 boolean debug(java.lang.String str)
          Sends the given string to the log file with the message level set to 'DEBUG'.
 boolean debug2(java.lang.String str)
          Sends the given string to the log file with the message level set to 'DEBUG2'.
 boolean debug3(java.lang.String str)
          Sends the given string to the log file with the message level set to 'DEBUG3'.
 boolean debug4(java.lang.String str)
          Sends the given string to the log file with the message level set to 'DEBUG4'.
 boolean debug5(java.lang.String str)
          Sends the given string to the log file with the message level set to 'DEBUG5'.
 boolean error(java.lang.String str)
          Sends the given string to the log file with the message level set to 'ERROR'.
 boolean info(java.lang.String str)
          Sends the given string to the log file with the message level set to 'INFO'.
 boolean isLoggable(int level)
          Determines if a message of the given level would actually be logged.
 boolean println(int level, java.lang.String str)
          Sends the given string to the log file.
 boolean println(int level, java.lang.String str, java.lang.Throwable t)
          Sends the given string to the log file.
 boolean println(java.lang.String str)
          Sends the given string to the log file.
 boolean warning(java.lang.String str)
          Sends the given string to the log file with the message level set to 'WARNING'.
 

Field Detail

ERROR

static final int ERROR
A message level value that denotes an error which causes the program to abort (3).

See Also:
Constant Field Values

WARNING

static final int WARNING
A message level value that denotes an unexpected condition, but the program continues (2).

See Also:
Constant Field Values

INFO

static final int INFO
A message level value that denotes an informational message (1).

See Also:
Constant Field Values

DEBUG

static final int DEBUG
A message level value that denotes a debug message, for developers only (0).

See Also:
Constant Field Values

DEBUG2

static final int DEBUG2
A message level value that denotes a lower-level debug (2) message, for developers only (-1).

See Also:
Constant Field Values

DEBUG3

static final int DEBUG3
A message level value that denotes a lower-level debug (3) message, for developers only (-2).

See Also:
Constant Field Values

DEBUG4

static final int DEBUG4
A message level value that denotes a lower-level debug (4) message, for developers only (-3).

See Also:
Constant Field Values

DEBUG5

static final int DEBUG5
A message level value that denotes a lower-level debug (5) message, for developers only (-4).

See Also:
Constant Field Values

ALL_MSGS

static final int ALL_MSGS
A message level value used to specify that all messages will be retained (-999).

See Also:
Constant Field Values

NO_MSGS

static final int NO_MSGS
A message level value used to specify that no messages will be retained (999).

See Also:
Constant Field Values

ERROR_STR

static final java.lang.String ERROR_STR
String version of a message level value that denotes an error which causes the program to abort.

See Also:
Constant Field Values

WARNING_STR

static final java.lang.String WARNING_STR
String version of a message level value that denotes an unexpected condition, but the program continues.

See Also:
Constant Field Values

INFO_STR

static final java.lang.String INFO_STR
String version of a message level value that denotes an informational message.

See Also:
Constant Field Values

DEBUG_STR

static final java.lang.String DEBUG_STR
String version of a message level value that denotes a debug message, for developers only.

See Also:
Constant Field Values

DEBUG2_STR

static final java.lang.String DEBUG2_STR
String version of a message level value that denotes a debug (2) message, for developers only.

See Also:
Constant Field Values

DEBUG3_STR

static final java.lang.String DEBUG3_STR
String version of a message level value that denotes a debug (3) message, for developers only.

See Also:
Constant Field Values

DEBUG4_STR

static final java.lang.String DEBUG4_STR
String version of a message level value that denotes a debug (4) message, for developers only.

See Also:
Constant Field Values

DEBUG5_STR

static final java.lang.String DEBUG5_STR
String version of a message level value that denotes a debug (5) message, for developers only.

See Also:
Constant Field Values

ALL_MSGS_STR

static final java.lang.String ALL_MSGS_STR
String version of a message level value used to specify that all messages will be retained.

See Also:
Constant Field Values

NO_MSGS_STR

static final java.lang.String NO_MSGS_STR
String version of a message level value used to specify that no messages will be retained.

See Also:
Constant Field Values
Method Detail

debug

boolean debug(java.lang.String str)
Sends the given string to the log file with the message level set to 'DEBUG'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

debug2

boolean debug2(java.lang.String str)
Sends the given string to the log file with the message level set to 'DEBUG2'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

debug3

boolean debug3(java.lang.String str)
Sends the given string to the log file with the message level set to 'DEBUG3'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

debug4

boolean debug4(java.lang.String str)
Sends the given string to the log file with the message level set to 'DEBUG4'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

debug5

boolean debug5(java.lang.String str)
Sends the given string to the log file with the message level set to 'DEBUG5'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

error

boolean error(java.lang.String str)
Sends the given string to the log file with the message level set to 'ERROR'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

info

boolean info(java.lang.String str)
Sends the given string to the log file with the message level set to 'INFO'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

isLoggable

boolean isLoggable(int level)
Determines if a message of the given level would actually be logged.

Parameters:
level - a message logging level.
Returns:
true if the given message level is currently being logged.

println

boolean println(int level,
                java.lang.String str)
Sends the given string to the log file. (And possibly the console--see the 'consoleLevel' parameter on the constructor.)

Parameters:
level - the message level to be used.
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

println

boolean println(int level,
                java.lang.String str,
                java.lang.Throwable t)
Sends the given string to the log file. (And possibly the console--see the 'consoleLevel' parameter on the constructor.)

Parameters:
level - the message level to be used.
str - the string to be outputted or null if only Throwable is used.
t - Throwable associated with a log message or null if none.
Returns:
true if successful, false if an I/O error was detected.

println

boolean println(java.lang.String str)
Sends the given string to the log file. (And possibly the console--see the 'consoleLevel' parameter on the constructor.)

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.

warning

boolean warning(java.lang.String str)
Sends the given string to the log file with the message level set to 'WARNING'.

Parameters:
str - the string to be outputted.
Returns:
true if successful, false if an I/O error was detected.