idebug
Interface DebugOutput

All Known Implementing Classes:

DebugOutputBase, ServletLogOutput, WriterOutput, WindowOutput, ConsoleOutput

public interface DebugOutput

The interface which all classes providing output methods used to send debugging messages to various types of devices must implement.

Version:

$Revision: 2146 $ $Date: 2005-02-13 16:54:27 +0000 (Sun, 13 Feb 2005) $

Author:

Joseph R. Kiniry

See Also:

DebugOutputBase

Method Summary

java.io.Writer	getWriter() Returns a Writer for this output interface if one is available.
boolean	isValidCategory(java.lang.String category) Tests to see if the current debug context is interested in a given category.
boolean	isValidLevel(int level) Tests to see if the current debug context is interested in a given level.
boolean	print(int level, java.lang.Object object) Print out an object if the debugging context warrents.
boolean	print(int level, java.lang.String message) Print out a debugging message if the debugging context warrents.
boolean	print(java.lang.String category, java.lang.Object object) Print out an object if the debugging context warrents.
boolean	print(java.lang.String category, java.lang.String message) Print out a debugging message if the debugging context warrents.
boolean	println(int level, java.lang.Object object) Print out an object if the debugging context warrents.
boolean	println(int level, java.lang.String message) Print out a debugging message if the debugging context warrents.
boolean	println(java.lang.String category, java.lang.Object object) Print out an object if the debugging context warrents.
boolean	println(java.lang.String category, java.lang.String message) Print out a debugging message if the debugging context warrents.
void	printMsg(int level, java.lang.String message) Print out the debugging message, no questions asked.
void	printMsg(java.lang.String message) Print out the debugging message, no questions asked.
void	printMsg(java.lang.String category, java.lang.String message) Print out the debugging message, no questions asked.

Method Detail

printMsg

public void printMsg(java.lang.String category,
                     java.lang.String message)

Print out the debugging message, no questions asked.

Parameters:

category - is the category of this message.

message - is the debugging message to print.

printMsg

public void printMsg(int level,
                     java.lang.String message)

Print out the debugging message, no questions asked.

Parameters:

level - The debugging level of this message.

message - The debugging message to print.

printMsg

public void printMsg(java.lang.String message)

Print out the debugging message, no questions asked.

Parameters:

message - The debugging message to print.

print

public boolean print(int level,
                     java.lang.String message)

Print out a debugging message if the debugging context warrents.

Parameters:

level - The debugging level of this message.

message - The debugging message to print.

print

public boolean print(int level,
                     java.lang.Object object)

Print out an object if the debugging context warrents.

Parameters:

level - The debugging level of this message.

object - The object to print.

print

public boolean print(java.lang.String category,
                     java.lang.String message)

Print out a debugging message if the debugging context warrents.

Parameters:

category - The category of this message.

message - The debugging message to print.

print

public boolean print(java.lang.String category,
                     java.lang.Object object)

Print out an object if the debugging context warrents.

Parameters:

category - The category of this message.

object - The object to print.

println

public boolean println(java.lang.String category,
                       java.lang.Object object)

Print out an object if the debugging context warrents.

Parameters:

category - The category of this message.

object - The object to print.

println

public boolean println(java.lang.String category,
                       java.lang.String message)

Print out a debugging message if the debugging context warrents.

Parameters:

category - The category of this message.

message - The debugging message to print.

println

public boolean println(int level,
                       java.lang.Object object)

Print out an object if the debugging context warrents.

Parameters:

level - The debugging level of this message.

object - The object to print.

println

public boolean println(int level,
                       java.lang.String message)

Print out a debugging message if the debugging context warrents.

Parameters:

level - The debugging level of this message.

message - The debugging message to print.

getWriter

public java.io.Writer getWriter()

Returns a Writer for this output interface if one is available.

Returns:

a Writer for this output interface if one is available.

See Also:

Writer

isValidCategory

public boolean isValidCategory(java.lang.String category)

Tests to see if the current debug context is interested in a given category.

Parameters:

category - the category to inspect.

Returns:

a boolean indicating if the category in question is valid at this time for this context (i.e. debugging framework state, thread, class invoking the method, etc.)

See Also:

Context

isValidLevel

public boolean isValidLevel(int level)

Tests to see if the current debug context is interested in a given level.

Parameters:

level - the level to inspect.

Returns:

a boolean indicating if the level in question is valid at this time for this context (i.e. debugging framework state, thread, class invoking the method, etc.)

See Also:

Context