| Methods Summary |
|---|
| public java.lang.String | getCategory()Get the category asscociated with this LogRecord. For a more detailed
description of what a category is see setCategory().
return (_category);
|
| public org.apache.log4j.lf5.LogLevel | getLevel()Get the level of this LogRecord.
return (_level);
|
| public java.lang.String | getLocation()Get the location in code where this LogRecord originated.
return _location;
|
| public java.lang.String | getMessage()Get the message asscociated with this LogRecord.
return (_message);
|
| public long | getMillis()Get the event time of this record in milliseconds from 1970.
When a LogRecord is constructed the event time is set but may be
overridden by calling setMillis();
return _millis;
|
| public java.lang.String | getNDC()Get the NDC (nested diagnostic context) for this record.
return _ndc;
|
| protected static synchronized long | getNextId()
_seqCount++;
return _seqCount;
|
| public long | getSequenceNumber()Get the sequence number associated with this LogRecord. Sequence numbers
are generally assigned when a LogRecord is constructed. Sequence numbers
start at 0 and increase with each newly constructed LogRocord.
return (_sequenceNumber);
|
| public java.lang.String | getThreadDescription()Get the thread description asscociated with this LogRecord. When a
LogRecord is constructed, the thread description is set by calling:
Thread.currentThread().toString(). You may supply a thread description
of your own by calling the setThreadDescription(String) method.
return (_thread);
|
| public java.lang.Throwable | getThrown()Get the Throwable associated with this LogRecord.
return (_thrown);
|
| public java.lang.String | getThrownStackTrace()Get the stack trace in a String-based format for the associated Throwable
of this LogRecord. The stack trace in a String-based format is set
when the setThrown(Throwable) method is called.
Why do we need this method considering that we
have the getThrown() and setThrown() methods?
A Throwable object may not be serializable, however, a String representation
of it is. Users of LogRecords should generally call this method over
getThrown() for the reasons of serialization.
return (_thrownStackTrace);
|
| public boolean | hasThrown()
Throwable thrown = getThrown();
if (thrown == null) {
return false;
}
String thrownString = thrown.toString();
return thrownString != null && thrownString.trim().length() != 0;
|
| public boolean | isFatal()
return isSevereLevel() || hasThrown();
|
| public abstract boolean | isSevereLevel()Abstract method. Must be overridden to indicate what log level
to show in red.
|
| public static synchronized void | resetSequenceNumber()Resets that sequence number to 0.
_seqCount = 0;
|
| public void | setCategory(java.lang.String category)Set the category associated with this LogRecord. A category represents
a hierarchical dot (".") separated namespace for messages.
The definition of a category is application specific, but a common convention
is as follows:
When logging messages
for a particluar class you can use its class name:
com.thoughtworks.framework.servlet.ServletServiceBroker.
Futhermore, to log a message for a particular method in a class
add the method name:
com.thoughtworks.framework.servlet.ServletServiceBroker.init().
_category = category;
|
| public void | setLevel(org.apache.log4j.lf5.LogLevel level)Set the level of this LogRecord.
_level = level;
|
| public void | setLocation(java.lang.String location)Set the location in code where this LogRecord originated.
_location = location;
|
| public void | setMessage(java.lang.String message)Set the message associated with this LogRecord.
_message = message;
|
| public void | setMillis(long millis)Set the event time of this record. When a LogRecord is constructed
the event time is set but may be overridden by calling this method.
_millis = millis;
|
| public void | setNDC(java.lang.String ndc)Set the NDC (nested diagnostic context) for this record.
_ndc = ndc;
|
| public void | setSequenceNumber(long number)Set the sequence number assocsiated with this LogRecord. A sequence number
will automatically be assigned to evey newly constructed LogRecord, however,
this method can override the value.
_sequenceNumber = number;
|
| public void | setThreadDescription(java.lang.String threadDescription)Set the thread description associated with this LogRecord. When a
LogRecord is constructed, the thread description is set by calling:
Thread.currentThread().toString(). You may supply a thread description
of your own by calling this method.
_thread = threadDescription;
|
| public void | setThrown(java.lang.Throwable thrown)Set the Throwable associated with this LogRecord. When this method
is called, the stack trace in a String-based format is made
available via the getThrownStackTrace() method.
if (thrown == null) {
return;
}
_thrown = thrown;
StringWriter sw = new StringWriter();
PrintWriter out = new PrintWriter(sw);
thrown.printStackTrace(out);
out.flush();
_thrownStackTrace = sw.toString();
try {
out.close();
sw.close();
} catch (IOException e) {
// Do nothing, this should not happen as it is StringWriter.
}
out = null;
sw = null;
|
| public void | setThrownStackTrace(java.lang.String trace)Set the ThrownStackTrace for the log record.
_thrownStackTrace = trace;
|
| public java.lang.String | toString()Return a String representation of this LogRecord.
StringBuffer buf = new StringBuffer();
buf.append("LogRecord: [" + _level + ", " + _message + "]");
return (buf.toString());
|
