public abstract class LogRecord extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
protected String |
_category |
protected LogLevel |
_level |
protected String |
_location |
protected String |
_message |
protected long |
_millis |
protected String |
_ndc |
protected static long |
_seqCount |
protected long |
_sequenceNumber |
protected String |
_thread |
protected Throwable |
_thrown |
protected String |
_thrownStackTrace |
Constructor and Description |
---|
LogRecord() |
Modifier and Type | Method and Description |
---|---|
String |
getCategory()
Get the category asscociated with this LogRecord.
|
LogLevel |
getLevel()
Get the level of this LogRecord.
|
String |
getLocation()
Get the location in code where this LogRecord originated.
|
String |
getMessage()
Get the message asscociated with this LogRecord.
|
long |
getMillis()
Get the event time of this record in milliseconds from 1970.
|
String |
getNDC()
Get the NDC (nested diagnostic context) for this record.
|
protected static long |
getNextId() |
long |
getSequenceNumber()
Get the sequence number associated with this LogRecord.
|
String |
getThreadDescription()
Get the thread description asscociated with this LogRecord.
|
Throwable |
getThrown()
Get the Throwable associated with this LogRecord.
|
String |
getThrownStackTrace()
Get the stack trace in a String-based format for the associated Throwable
of this LogRecord.
|
boolean |
hasThrown() |
boolean |
isFatal() |
abstract boolean |
isSevereLevel()
Abstract method.
|
static void |
resetSequenceNumber()
Resets that sequence number to 0.
|
void |
setCategory(String category)
Set the category associated with this LogRecord.
|
void |
setLevel(LogLevel level)
Set the level of this LogRecord.
|
void |
setLocation(String location)
Set the location in code where this LogRecord originated.
|
void |
setMessage(String message)
Set the message associated with this LogRecord.
|
void |
setMillis(long millis)
Set the event time of this record.
|
void |
setNDC(String ndc)
Set the NDC (nested diagnostic context) for this record.
|
void |
setSequenceNumber(long number)
Set the sequence number assocsiated with this LogRecord.
|
void |
setThreadDescription(String threadDescription)
Set the thread description associated with this LogRecord.
|
void |
setThrown(Throwable thrown)
Set the Throwable associated with this LogRecord.
|
void |
setThrownStackTrace(String trace)
Set the ThrownStackTrace for the log record.
|
String |
toString()
Return a String representation of this LogRecord.
|
protected static long _seqCount
protected long _sequenceNumber
protected long _millis
protected String _thrownStackTrace
public LogRecord()
public LogLevel getLevel()
setLevel(LogLevel)
,
LogLevel
public void setLevel(LogLevel level)
level
- The LogLevel for this record.getLevel()
,
LogLevel
public abstract boolean isSevereLevel()
public boolean hasThrown()
public boolean isFatal()
public String getCategory()
setCategory(String)
public void setCategory(String category)
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
- The category for this record.getCategory()
public String getMessage()
setMessage(String)
public void setMessage(String message)
message
- The message for this record.getMessage()
public long getSequenceNumber()
setSequenceNumber(long)
public void setSequenceNumber(long number)
number
- The sequence number.getSequenceNumber()
public long getMillis()
setMillis(long)
public void setMillis(long millis)
millis
- The time in milliseconds from 1970.getMillis()
public String getThreadDescription()
setThreadDescription(String)
public void setThreadDescription(String threadDescription)
threadDescription
- The description of the thread for this record.getThreadDescription()
public String getThrownStackTrace()
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.
setThrown(Throwable)
,
getThrown()
public void setThrownStackTrace(String trace)
trace
- A String to associate with this LogRecordgetThrownStackTrace()
public Throwable getThrown()
setThrown(Throwable)
,
getThrownStackTrace()
public void setThrown(Throwable thrown)
thrown
- A Throwable to associate with this LogRecord.getThrown()
,
getThrownStackTrace()
public String getNDC()
public void setNDC(String ndc)
ndc
- A string representing the NDC.public String getLocation()
public void setLocation(String location)
location
- A string containing location information.public static void resetSequenceNumber()
protected static long getNextId()
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses