IDebug
© 1997-2001 Joseph Kiniry
© 2000-2001 KindSoftware
© 1997-1999 Caltech
All Rights Reserved
A C D E F G H I L M N P R S T U V W

A

addCategory(String, int) - Method in class idebug.Context
Adds a category to the database of legal debugging categories for the owner thread.
addCategory(String, int) - Method in class idebug.Debug
Adds a category to the database of legal debugging categories.
addClass(Class) - Method in class idebug.Context
Adds a class to this Context's database of classes that have debugging enabled.
addClass(Class) - Method in class idebug.Debug
Adds a class the the class-global database of classes that have debugging enabled.
addClass(String) - Method in class idebug.Context
Adds a class to this Context's database of classes that have debugging enabled.
addClass(String) - Method in class idebug.Debug
Adds a class the the class-global database of classes that have debugging enabled.
addContext(Context) - Method in class idebug.Debug
Adds a context to the the class-global database of threads that have debugging context.
Assert - class idebug.Assert.
The core interface to making assertions.
assert(boolean) - Static method in class idebug.Assert
Assert that the passed boolean expression evaluates to true.
assert(boolean, String) - Method in class idebug.Assert
Assert that the passed boolean expression evaluates to true.
assert(boolean, String, Object) - Method in class idebug.Assert
Assert that the passed boolean expression evaluates to true.
ASSERTION - Static variable in interface idebug.DebugConstants
The highest level category that exists.
ASSERTION - Static variable in interface idebug.examples.FrenchConstants
 
ASSERTION_LEVEL - Static variable in interface idebug.DebugConstants
The highest level category that exists.
ASSERTION_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 

C

checkDebugCollectRef(Debug) - Method in class idebug.Collect
Checks a debug instance to make sure its collect attribute references this Collect object.
checkLevel(int) - Method in interface idebug.DebugConstants
Check whether a level is valid, that is, bound byte the minimum and maximum levels of this interface's implementation.
checkLevel(int) - Method in class idebug.DefaultDebugConstants
 
checkStatisticID(Statistic) - Method in class idebug.Collect
Check the ID of a statistic and make sure that it hasn't changed since it was registered.
clone() - Method in class idebug.WriterOutput
 
clone() - Method in class idebug.SimpleCollect
 
clone() - Method in class idebug.Context
Used to clone a Context for another thread.
clone() - Method in class idebug.ServletLogOutput
 
clone() - Method in class idebug.Debug
 
clone() - Method in class idebug.WindowOutput
 
clone() - Method in class idebug.Event
 
clone() - Method in class idebug.ConsoleOutput
 
clone() - Method in class idebug.Assert
 
clone() - Method in class idebug.examples.SimpleCollect
 
Collect - class idebug.Collect.
The core interface to gathering statistics.
Collect() - Constructor for class idebug.Collect
Construct a new Collect class.
ConsoleOutput - class idebug.ConsoleOutput.
The primary class used to send debugging messages to the Java console via the stderr file descriptor.
ConsoleOutput(Debug) - Constructor for class idebug.ConsoleOutput
Construct a new ConsoleOutput class.
containsCategory(String) - Method in class idebug.Context
 
containsCategory(String) - Method in class idebug.Debug
Returns a boolean indicating if a category is in the class-global category database.
containsClass(Class) - Method in class idebug.Context
 
containsClass(String) - Method in class idebug.Context
 
Context - class idebug.Context.
Context is the data structure that holds the information that is relevent to debugging on a per-thread and a per- threadgroup basis.
Context(DebugConstants, DebugOutput) - Constructor for class idebug.Context
The standard constructor.
CRITICAL - Static variable in interface idebug.DebugConstants
Very important problems/errors that will eventually cause Failures or Assertions should be tagged as Critical.
CRITICAL - Static variable in interface idebug.examples.FrenchConstants
 
CRITICAL_LEVEL - Static variable in interface idebug.DebugConstants
Very important problems/errors that will eventually cause Failures or Assertions should be tagged as Critical.
CRITICAL_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 
currentValue(Statistic) - Method in class idebug.Collect
What is the current value for specific statistic?
currentValue(Statistic) - Method in class idebug.SimpleCollect
What is the current value for specific statistic?
currentValue(Statistic) - Method in class idebug.examples.SimpleCollect
What is the current value for specific statistic?

D

debug - Variable in class idebug.DebugOutputBase
The Debug object associated with this output object.
Debug - class idebug.Debug.
Debug is the core class of the IDebug debugging facilities.
Debug() - Constructor for class idebug.Debug
Construct a new Debug class.
Debug(DebugConstants, Collect) - Constructor for class idebug.Debug
Construct a new Debug class.
DebugConstants - interface idebug.DebugConstants.
DebugConstants is an interface that collects the various constants of the debugging package including debug level ranges, standard debugging messages, statistics definitions, etc.
DebugOutput - interface idebug.DebugOutput.
The interface which all classes providing output methods used to send debugging messages to various types of devices must implement.
DebugOutputBase - class idebug.DebugOutputBase.
The abstract class from which all classes providing output methods used to send debugging messages to various types of devices must inherit.
DebugOutputBase() - Constructor for class idebug.DebugOutputBase
 
debugOutputInterface - Variable in class idebug.Debug
The class used by this thread to control debugging output device.
decrement(Statistic) - Method in class idebug.Collect
Decrement a statistic by the default value.
decrement(Statistic) - Method in class idebug.SimpleCollect
Decrement a statistic by the default value.
decrement(Statistic) - Method in class idebug.examples.SimpleCollect
Decrement a statistic by the default value.
decrement(Statistic, double) - Method in class idebug.Collect
Decrement a statistic by a specified value.
decrement(Statistic, double) - Method in class idebug.SimpleCollect
Decrement a statistic by a specified value.
decrement(Statistic, double) - Method in class idebug.examples.SimpleCollect
Decrement a statistic by a specified value.
DefaultDebugConstants - class idebug.DefaultDebugConstants.
The default implementation of debug semantics for the IDebug framework.
DefaultDebugConstants() - Constructor for class idebug.DefaultDebugConstants
 

E

equals(Object) - Method in class idebug.Event
Is this event equal to another one?
ERROR - Static variable in interface idebug.DebugConstants
This is the standard error level.
ERROR - Static variable in interface idebug.examples.FrenchConstants
 
ERROR_LEVEL - Static variable in interface idebug.DebugConstants
This is the standard error level.
ERROR_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 
ERROR_STRING - Static variable in interface idebug.DebugConstants
An error message that can be localized or otherwise customized.
ERROR_STRING - Static variable in interface idebug.examples.FrenchConstants
Various messages that can be localized or otherwise customized.
Event - class idebug.Event.
Event is a utility base class from which all log/monitoring events can derive or have embedded.
Event(String, String, String, String, int) - Constructor for class idebug.Event
This the standard constructor for Event.

F

FAILED_ASSERTION_STRING - Static variable in interface idebug.DebugConstants
An assertion failure message that can be localized or otherwise customized.
FAILED_ASSERTION_STRING - Static variable in interface idebug.examples.FrenchConstants
 
FailedAssertionException - error idebug.FailedAssertionException.
The runtime exception thrown when an assertion is violated.
FailedAssertionException() - Constructor for class idebug.FailedAssertionException
 
FailedAssertionException(String) - Constructor for class idebug.FailedAssertionException
 
FAILURE - Static variable in interface idebug.DebugConstants
The highest level category that exists.
FAILURE - Static variable in interface idebug.examples.FrenchConstants
 
FAILURE_LEVEL - Static variable in interface idebug.DebugConstants
The highest level category that exists.
FAILURE_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 
FrenchConstants - interface idebug.examples.FrenchConstants.
FrenchConstants is an interface that collects the various constants of the debugging package including debug level ranges, standard debugging messages, etc.

G

getAssert() - Method in class idebug.Debug
 
getCategoryLevel(String) - Method in class idebug.Context
 
getCollect() - Method in class idebug.Debug
 
getContext(Thread) - Method in class idebug.Debug
Get the context for a specific thread.
getCreationDate() - Method in class idebug.Event
When was this event generated?
getDebugConstants() - Method in class idebug.Debug
 
getDecrement() - Method in class idebug.Statistic
What is its default decrement?
getDescription() - Method in class idebug.Event
What is the description of this event?
getID() - Method in class idebug.Statistic
What is the unique ID of this statistic?
getIncrement() - Method in class idebug.Statistic
What is its default increment?
getLevel() - Method in class idebug.Context
 
getLevel() - Method in class idebug.Debug
Returns the current class-global debugging level.
getLevel() - Method in class idebug.Event
How important is this event?
getOutputInterface() - Method in class idebug.Context
 
getOutputInterface() - Method in class idebug.Debug
 
getScale() - Method in class idebug.Statistic
What is its default scaling factor?
getSourceComponent() - Method in class idebug.Event
What is the source component of this event?
getSourceHost() - Method in class idebug.Event
What is the source system of this event?
getStart() - Method in class idebug.Statistic
What is its default start value?
getThread() - Method in class idebug.Context
 
getType() - Method in class idebug.Event
What type of event is this?
getUnits() - Method in class idebug.Statistic
What are its units?
getWriter() - Method in class idebug.DebugOutputBase
Returns a Writer for this output interface if one is available.
getWriter() - Method in class idebug.WriterOutput
 
getWriter() - Method in class idebug.ServletLogOutput
 
getWriter() - Method in interface idebug.DebugOutput
Returns a Writer for this output interface if one is available.
getWriter() - Method in class idebug.WindowOutput
 
getWriter() - Method in class idebug.ConsoleOutput
 

H

hashCode() - Method in class idebug.Statistic
 

I

idebug - package idebug
 
idebug.examples - package idebug.examples
 
idebug.testsuite - package idebug.testsuite
 
increment(Statistic) - Method in class idebug.Collect
Increment a statistic by the default value.
increment(Statistic) - Method in class idebug.SimpleCollect
Increment a statistic by the default value.
increment(Statistic) - Method in class idebug.examples.SimpleCollect
Increment a statistic by the default value.
increment(Statistic, double) - Method in class idebug.Collect
Increment a statistic by a specified value.
increment(Statistic, double) - Method in class idebug.SimpleCollect
Increment a statistic by a specified value.
increment(Statistic, double) - Method in class idebug.examples.SimpleCollect
Increment a statistic by a specified value.
initCategories(Hashtable) - Method in interface idebug.DebugConstants
Initializes default categories of debugging facilities.
initCategories(Hashtable) - Method in class idebug.DefaultDebugConstants
Initializes default categories of debugging facilities.
initCategories(Hashtable) - Method in interface idebug.examples.FrenchConstants
 
INVALID_THREAD - Static variable in interface idebug.DebugConstants
Indicates that an invalid thread was passed to a thread-related method in idebug.Debug.
INVALID_THREAD - Static variable in interface idebug.examples.FrenchConstants
 
isOff() - Method in class idebug.Debug
Returns a boolean indicating if any debugging is turned off.
isOff(Thread) - Method in class idebug.Debug
Returns a boolean indicating whether any debugging facilities are turned off for a particular thread.
isOn() - Method in class idebug.Context
 
isOn() - Method in class idebug.Debug
Returns a boolean indicating if any debugging is turned on.
isOn(Thread) - Method in class idebug.Debug
Returns a boolean indicating whether any debugging facilities are turned on for a particular thread.
isRegistered(Statistic) - Method in class idebug.Collect
Check to see if a statistic is registered yet.
isValidCategory(String) - Method in class idebug.DebugOutputBase
Tests to see if the current debug context is interested in a given category.
isValidCategory(String) - Method in class idebug.Collect
Tests to see if the current debug context is interested in a given category.
isValidCategory(String) - Method in interface idebug.DebugOutput
Tests to see if the current debug context is interested in a given category.
isValidLevel(int) - Method in class idebug.DebugOutputBase
Tests to see if the current debug context is interested in a given level.
isValidLevel(int) - Method in class idebug.Collect
Tests to see if the current debug context is interested in a given level.
isValidLevel(int) - Method in interface idebug.DebugOutput
Tests to see if the current debug context is interested in a given level.

L

LEVEL_MAX - Static variable in interface idebug.DebugConstants
The maximum debug level.
LEVEL_MAX - Static variable in interface idebug.examples.FrenchConstants
The maximum debug level.
LEVEL_MIN - Static variable in interface idebug.DebugConstants
The minimum debug level.
LEVEL_MIN - Static variable in interface idebug.examples.FrenchConstants
The minimum debug level.
listCategories() - Method in class idebug.Context
 
listCategories() - Method in class idebug.Debug
Returns an Enumeration that is the list of class-global debugging categories that are currently in the category database.
listClasses() - Method in class idebug.Context
Returns an enumeration that is the list of classes that have debugging enabled in this Context.
listClasses() - Method in class idebug.Debug
Returns an Enumeration that is the list of class-global classes that have debugging enabled.
listThreads() - Method in class idebug.Debug
Returns an Enumeration that is the list of class-global threads that have debugging enabled.

M

main(String[]) - Static method in class idebug.testsuite.TestSuite
A main() that contains the test code for the Debug class.

N

NOTICE - Static variable in interface idebug.DebugConstants
A notice is simply a progress message.
NOTICE - Static variable in interface idebug.examples.FrenchConstants
 
NOTICE_LEVEL - Static variable in interface idebug.DebugConstants
A notice is simply a progress message.
NOTICE_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 

P

print(int, Object) - Method in class idebug.DebugOutputBase
Print out an object if the debugging context warrents.
print(int, Object) - Method in interface idebug.DebugOutput
Print out an object if the debugging context warrents.
print(int, String) - Method in class idebug.DebugOutputBase
Print out a debugging message if the debugging context warrents.
print(int, String) - Method in interface idebug.DebugOutput
Print out a debugging message if the debugging context warrents.
print(String, Object) - Method in class idebug.DebugOutputBase
Print out an object if the debugging context warrents.
print(String, Object) - Method in interface idebug.DebugOutput
Print out an object if the debugging context warrents.
print(String, String) - Method in class idebug.DebugOutputBase
Print out a debugging message if the debugging context warrents.
print(String, String) - Method in interface idebug.DebugOutput
Print out a debugging message if the debugging context warrents.
println(int, Object) - Method in class idebug.DebugOutputBase
Print out an object if the debugging context warrents.
println(int, Object) - Method in interface idebug.DebugOutput
Print out an object if the debugging context warrents.
println(int, String) - Method in class idebug.DebugOutputBase
Print out a debugging message if the debugging context warrents.
println(int, String) - Method in interface idebug.DebugOutput
Print out a debugging message if the debugging context warrents.
println(String, Object) - Method in class idebug.DebugOutputBase
Print out an object if the debugging context warrents.
println(String, Object) - Method in interface idebug.DebugOutput
Print out an object if the debugging context warrents.
println(String, String) - Method in class idebug.DebugOutputBase
Print out a debugging message if the debugging context warrents.
println(String, String) - Method in interface idebug.DebugOutput
Print out a debugging message if the debugging context warrents.
printMsg(int, String) - Method in class idebug.DebugOutputBase
Print out the debugging message, no questions asked.
printMsg(int, String) - Method in class idebug.WriterOutput
 
printMsg(int, String) - Method in class idebug.ServletLogOutput
 
printMsg(int, String) - Method in interface idebug.DebugOutput
Print out the debugging message, no questions asked.
printMsg(int, String) - Method in class idebug.WindowOutput
 
printMsg(int, String) - Method in class idebug.ConsoleOutput
 
printMsg(String) - Method in class idebug.DebugOutputBase
Print out the debugging message, no questions asked.
printMsg(String) - Method in class idebug.WriterOutput
 
printMsg(String) - Method in class idebug.ServletLogOutput
 
printMsg(String) - Method in interface idebug.DebugOutput
Print out the debugging message, no questions asked.
printMsg(String) - Method in class idebug.WindowOutput
 
printMsg(String) - Method in class idebug.ConsoleOutput
 
printMsg(String, String) - Method in class idebug.DebugOutputBase
Print out the debugging message, no questions asked.
printMsg(String, String) - Method in class idebug.WriterOutput
 
printMsg(String, String) - Method in class idebug.ServletLogOutput
 
printMsg(String, String) - Method in interface idebug.DebugOutput
Print out the debugging message, no questions asked.
printMsg(String, String) - Method in class idebug.WindowOutput
 
printMsg(String, String) - Method in class idebug.ConsoleOutput
 

R

register(Statistic) - Method in class idebug.Collect
Register a statistic with the collector.
register(Statistic) - Method in class idebug.SimpleCollect
Register a statistic with the collector.
register(Statistic) - Method in class idebug.examples.SimpleCollect
Register a statistic with the collector.
removeCategory(String) - Method in class idebug.Context
Removes a category from the database of legal debugging categories for the owner thread.
removeCategory(String) - Method in class idebug.Debug
Removes a category to the database of legal debugging categories.
removeClass(Class) - Method in class idebug.Context
Removes a class from this Context's database of classes that have debugging enabled.
removeClass(Class) - Method in class idebug.Debug
Removes a class the the class-global database of classes that have debugging enabled.
removeClass(String) - Method in class idebug.Context
Removes a class from this Context's database of classes that have debugging enabled.
removeClass(String) - Method in class idebug.Debug
Removes a class the the class-global database of classes that have debugging enabled.
removeContext(Context) - Method in class idebug.Debug
Removes a context from the the class-global database of threads that have debugging context.
report(Statistic) - Method in class idebug.Collect
Report on a particular statistic.
report(Statistic) - Method in class idebug.SimpleCollect
Report on a particular statistic.
report(Statistic) - Method in class idebug.examples.SimpleCollect
Report on a particular statistic.
reportAll() - Method in class idebug.Collect
Report on all statistics.
reportAll() - Method in class idebug.SimpleCollect
Report on all statistics.
reportAll() - Method in class idebug.examples.SimpleCollect
Report on all statistics.
reset(Statistic) - Method in class idebug.Collect
Reset a statistic to the default start value.
reset(Statistic) - Method in class idebug.SimpleCollect
Reset a statistic to the default start value.
reset(Statistic) - Method in class idebug.examples.SimpleCollect
Reset a statistic to the default start value.
run() - Method in class idebug.testsuite.TestSuiteThread
 

S

ServletLogOutput - class idebug.ServletLogOutput.
The class used to send debugging messages from within Java servlets.
ServletLogOutput(Debug) - Constructor for class idebug.ServletLogOutput
Construct a new ServletLogOutput object for debugging purposes.
ServletLogOutput(Debug, ServletContext) - Constructor for class idebug.ServletLogOutput
Construct a new ServletLogOutput object.
set(Statistic, double) - Method in class idebug.Collect
Set a statistic to a specific value.
set(Statistic, double) - Method in class idebug.SimpleCollect
Set a statistic to a specific value.
set(Statistic, double) - Method in class idebug.examples.SimpleCollect
Set a statistic to a specific value.
setDebug(Debug) - Method in class idebug.Collect
Set the debug instance associated with this collect instance.
setLevel(int) - Method in class idebug.Context
Set a new debugging level for the owning thread.
setLevel(int) - Method in class idebug.Debug
Set a new class-global debugging level.
setOutputInterface(DebugOutput) - Method in class idebug.Debug
Set the global output interface to a new DebugOutput.
setPrintWriter(PrintWriter) - Method in class idebug.WriterOutput
Set a new PrintWriter.
SimpleCollect - class idebug.SimpleCollect.
A default simple core interface to gathering statistics.
SimpleCollect - class idebug.examples.SimpleCollect.
A default simple core interface to gathering statistics.
SimpleCollect() - Constructor for class idebug.SimpleCollect
Construct a new SimpleCollect class.
SimpleCollect() - Constructor for class idebug.examples.SimpleCollect
Construct a new SimpleCollect class.
Statistic - class idebug.Statistic.
This class represents a statistic that can be monitored in the monitoring system.
Statistic(String, double, float, float, float) - Constructor for class idebug.Statistic
This the standard constructor for Statistic.

T

TestSuite - class idebug.testsuite.TestSuite.
TestSuite is a black-box test suite for the Debug class.
TestSuite() - Constructor for class idebug.testsuite.TestSuite
 
TestSuiteThread - class idebug.testsuite.TestSuiteThread.
TestSuite is the black-box testsuite for the Debug class.
toString() - Method in class idebug.Event
What is a printable representation of this event?
turnOff() - Method in class idebug.Context
Turns off debugging facilities for the owner thread.
turnOff() - Method in class idebug.Debug
Turns off class-global debugging facilities.
turnOn() - Method in class idebug.Context
Turns on debugging facilities for the owner thread.
turnOn() - Method in class idebug.Debug
Turns on class-global debugging facilities.

U

unregister(Statistic) - Method in class idebug.Collect
Unregister a statistic with the collector.
unregister(Statistic) - Method in class idebug.SimpleCollect
Unregister a statistic with the collector.
unregister(Statistic) - Method in class idebug.examples.SimpleCollect
Unregister a statistic with the collector.

V

validLevel(int) - Method in class idebug.Context
 

W

WARNING - Static variable in interface idebug.DebugConstants
A warning is a message that says something has gone wrong but it's not terribly serious.
WARNING - Static variable in interface idebug.examples.FrenchConstants
 
WARNING_LEVEL - Static variable in interface idebug.DebugConstants
A warning is a message that says something has gone wrong but it's not terribly serious.
WARNING_LEVEL - Static variable in interface idebug.examples.FrenchConstants
 
WindowOutput - class idebug.WindowOutput.
The primary class used to send messages to a window created by the IDebug framework.
WindowOutput(Debug) - Constructor for class idebug.WindowOutput
Construct a new WindowOutput class.
WriterOutput - class idebug.WriterOutput.
The primary class used to send debugging messages to a PrintWriter output channel.
WriterOutput(Debug) - Constructor for class idebug.WriterOutput
Constructor for WriterOutput.
WriterOutput(Debug, PrintWriter) - Constructor for class idebug.WriterOutput
Constructor for WriterOutput.

A C D E F G H I L M N P R S T U V W
IDebug
© 1997-2001 Joseph Kiniry
© 2000-2001 KindSoftware
© 1997-1999 Caltech
All Rights Reserved