shared
Class LogOptions

java.lang.Object
  |
  +--shared.LogOptions

public class LogOptions

extends java.lang.Object

Provide support for MLC++ logging.

Constructor Summary

LogOptions()
Constructor.

LogOptions(java.lang.String logOptionName)
Constructor.

Method Summary

void	DRIBBLE(java.lang.String dribbleMessage) If the dribble is set to TRUE, this method displays the given message.
void	ERR(int logNumber, java.lang.String errMessage) Displays an error message.
int	get_log_level() Returns the log level.
LogOptions	get_log_options() Returns this LogOptions.
java.io.Writer	get_log_stream() Returns the stream used for display.
static void	GLOBLOG(int logNumber, char logChar) Displays log message according to the global log level.
static void	GLOBLOG(int logNumber, java.lang.String logMessage) Displays log message according to the global log level.
void	LOG(int logNumber, char logChar) Displays a log message.
void	LOG(int logNumber, java.lang.String logMessage) Displays a log message.
void	set_log_level(int level) Sets the log level.
void	set_log_options(LogOptions opt) Set LogOptions based on another instance as prototype.
void	set_log_prefixes(java.lang.String file, int line) Sets prefixes displayed before log message.
void	set_log_prefixes(java.lang.String file, int line, int stmtLogLevel, int lgLevel) Sets prefixes displayed before log message.
void	set_log_stream(java.io.Writer strm) Sets the display stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogOptions

public LogOptions()

Constructor.

LogOptions

public LogOptions(java.lang.String logOptionName)

Constructor.

Parameters:

logOptionName - The name of the log level option.

Method Detail

set_log_options

public void set_log_options(LogOptions opt)

Set LogOptions based on another instance as prototype.

Parameters:

opt - The LogOptions instance copied.

set_log_level

public void set_log_level(int level)

Sets the log level. Negative log levels are turned into 0. This allows calls such as set_log_level(get_log_level() - 3).

Parameters:

level - The new log level.

get_log_level

public int get_log_level()

Returns the log level.

Returns:

The log level.

set_log_stream

public void set_log_stream(java.io.Writer strm)

Sets the display stream.

Parameters:

strm - The stream to be written to.

get_log_stream

public java.io.Writer get_log_stream()

Returns the stream used for display.

Returns:

The stream used for display.

set_log_prefixes

public void set_log_prefixes(java.lang.String file,
                             int line)

Sets prefixes displayed before log message.

Parameters:

file - The name of the file containing this log message.

line - Line number of log message.

set_log_prefixes

public void set_log_prefixes(java.lang.String file,
                             int line,
                             int stmtLogLevel,
                             int lgLevel)

Sets prefixes displayed before log message.

Parameters:

file - The name of the file containing this log message.

line - Line number of log message.

stmtLogLevel - The log level of the log message statement.

lgLevel - The current log level being displayed.

get_log_options

public LogOptions get_log_options()

Returns this LogOptions.

Returns:

This LogOptions object.

LOG

public void LOG(int logNumber,
                java.lang.String logMessage)

Displays a log message.

Parameters:

logNumber - The log number of the message.

logMessage - The message being displayed.

LOG

public void LOG(int logNumber,
                char logChar)

Displays a log message.

Parameters:

logNumber - The log number of the message.

logChar - The message being displayed.

ERR

public void ERR(int logNumber,
                java.lang.String errMessage)

Displays an error message.

Parameters:

logNumber - The log level of the error message.

errMessage - The error message.

GLOBLOG

public static void GLOBLOG(int logNumber,
                           java.lang.String logMessage)

Displays log message according to the global log level.

Parameters:

logNumber - The log number of the message.

logMessage - The message to be displayed.

GLOBLOG

public static void GLOBLOG(int logNumber,
                           char logChar)

Displays log message according to the global log level.

Parameters:

logNumber - The log number of the message.

logChar - The message to be displayed.

DRIBBLE

public void DRIBBLE(java.lang.String dribbleMessage)

If the dribble is set to TRUE, this method displays the given message.

Parameters:

dribbleMessage - The message to be displayed.

See Also:

GlobalOptions.dribble