Save This Page
Home » apache-log4j-1.2.15 » org.apache » log4j » lf5 » [javadoc | source]
org.apache.log4j.lf5
abstract public class: LogRecord [javadoc | source]
java.lang.Object
   org.apache.log4j.lf5.LogRecord

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    AdapterLogRecord, Log4JLogRecord

LogRecord. A LogRecord encapsulates the details of your desired log request.
Field Summary
protected static  long _seqCount     
protected  LogLevel _level     
protected  String _message     
protected  long _sequenceNumber     
protected  long _millis     
protected  String _category     
protected  String _thread     
protected  String _thrownStackTrace     
protected  Throwable _thrown     
protected  String _ndc     
protected  String _location     
Constructor:
 public LogRecord() 
Method from org.apache.log4j.lf5.LogRecord Summary:
getCategory,   getLevel,   getLocation,   getMessage,   getMillis,   getNDC,   getNextId,   getSequenceNumber,   getThreadDescription,   getThrown,   getThrownStackTrace,   hasThrown,   isFatal,   isSevereLevel,   resetSequenceNumber,   setCategory,   setLevel,   setLocation,   setMessage,   setMillis,   setNDC,   setSequenceNumber,   setThreadDescription,   setThrown,   setThrownStackTrace,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.log4j.lf5.LogRecord Detail:
 public String getCategory() 
    Get the category asscociated with this LogRecord. For a more detailed description of what a category is see setCategory().
 public LogLevel getLevel() 
    Get the level of this LogRecord.
 public String getLocation() 
    Get the location in code where this LogRecord originated.
 public String getMessage() 
    Get the message asscociated with this LogRecord.
 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();
 public String getNDC() 
    Get the NDC (nested diagnostic context) for this record.
 protected static synchronized long getNextId() 
 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.
 public 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.
 public Throwable getThrown() 
    Get the Throwable associated with this LogRecord.
 public 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.

 public boolean hasThrown() 
 public boolean isFatal() 
 abstract public 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.
 public  void setCategory(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().

 public  void setLevel(LogLevel level) 
    Set the level of this LogRecord.
 public  void setLocation(String location) 
    Set the location in code where this LogRecord originated.
 public  void setMessage(String message) 
    Set the message associated with this LogRecord.
 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.
 public  void setNDC(String ndc) 
    Set the NDC (nested diagnostic context) for this record.
 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.
 public  void setThreadDescription(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.
 public  void setThrown(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.
 public  void setThrownStackTrace(String trace) 
    Set the ThrownStackTrace for the log record.
 public String toString() 
    Return a String representation of this LogRecord.