Home » openjdk-7 » java » util » logging » [javadoc | source]
java.util.logging
public class: LogRecord [javadoc | source]
java.lang.Object
   java.util.logging.LogRecord

All Implemented Interfaces:
    java$io$Serializable

LogRecord objects are used to pass logging requests between the logging framework and individual log Handlers.

When a LogRecord is passed into the logging framework it logically belongs to the framework and should no longer be used or updated by the client application.

Note that if the client application has not specified an explicit source method name and source class name, then the LogRecord class will infer them automatically when they are first accessed (due to a call on getSourceMethodName or getSourceClassName) by analyzing the call stack. Therefore, if a logging Handler wants to pass off a LogRecord to another thread, or to transmit it over RMI, and if it wishes to subsequently obtain method name or class name information it should call one of getSourceClassName or getSourceMethodName to force the values to be filled in.

Serialization notes:

Constructor:
 public LogRecord(Level level,
    String msg) 
    Construct a LogRecord with the given level and message values.

    The sequence property will be initialized with a new unique value. These sequence values are allocated in increasing order within a VM.

    The millis property will be initialized to the current time.

    The thread ID property will be initialized with a unique ID for the current thread.

    All other properties will be initialized to "null".

    Parameters:
    level - a logging level value
    msg - the raw non-localized logging message (may be null)
Method from java.util.logging.LogRecord Summary:
getLevel,   getLoggerName,   getMessage,   getMillis,   getParameters,   getResourceBundle,   getResourceBundleName,   getSequenceNumber,   getSourceClassName,   getSourceMethodName,   getThreadID,   getThrown,   setLevel,   setLoggerName,   setMessage,   setMillis,   setParameters,   setResourceBundle,   setResourceBundleName,   setSequenceNumber,   setSourceClassName,   setSourceMethodName,   setThreadID,   setThrown
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.logging.LogRecord Detail:
 public Level getLevel() 
    Get the logging message level, for example Level.SEVERE.
 public String getLoggerName() 
    Get the source Logger's name.
 public String getMessage() 
    Get the "raw" log message, before localization or formatting.

    May be null, which is equivalent to the empty string "".

    This message may be either the final text or a localization key.

    During formatting, if the source logger has a localization ResourceBundle and if that ResourceBundle has an entry for this message string, then the message string is replaced with the localized value.

 public long getMillis() 
    Get event time in milliseconds since 1970.
 public Object[] getParameters() 
    Get the parameters to the log message.
 public ResourceBundle getResourceBundle() 
    Get the localization resource bundle

    This is the ResourceBundle that should be used to localize the message string before formatting it. The result may be null if the message is not localizable, or if no suitable ResourceBundle is available.

 public String getResourceBundleName() 
    Get the localization resource bundle name

    This is the name for the ResourceBundle that should be used to localize the message string before formatting it. The result may be null if the message is not localizable.

 public long getSequenceNumber() 
    Get the sequence number.

    Sequence numbers are normally assigned in the LogRecord constructor, which assigns unique sequence numbers to each new LogRecord in increasing order.

 public String getSourceClassName() 
    Get the name of the class that (allegedly) issued the logging request.

    Note that this sourceClassName is not verified and may be spoofed. This information may either have been provided as part of the logging call, or it may have been inferred automatically by the logging framework. In the latter case, the information may only be approximate and may in fact describe an earlier call on the stack frame.

    May be null if no information could be obtained.

 public String getSourceMethodName() 
    Get the name of the method that (allegedly) issued the logging request.

    Note that this sourceMethodName is not verified and may be spoofed. This information may either have been provided as part of the logging call, or it may have been inferred automatically by the logging framework. In the latter case, the information may only be approximate and may in fact describe an earlier call on the stack frame.

    May be null if no information could be obtained.

 public int getThreadID() 
    Get an identifier for the thread where the message originated.

    This is a thread identifier within the Java VM and may or may not map to any operating system ID.

 public Throwable getThrown() 
    Get any throwable associated with the log record.

    If the event involved an exception, this will be the exception object. Otherwise null.

 public  void setLevel(Level level) 
    Set the logging message level, for example Level.SEVERE.
 public  void setLoggerName(String name) 
    Set the source Logger's name.
 public  void setMessage(String message) 
    Set the "raw" log message, before localization or formatting.
 public  void setMillis(long millis) 
    Set event time.
 public  void setParameters(Object[] parameters) 
    Set the parameters to the log message.
 public  void setResourceBundle(ResourceBundle bundle) 
    Set the localization resource bundle.
 public  void setResourceBundleName(String name) 
    Set the localization resource bundle name.
 public  void setSequenceNumber(long seq) 
    Set the sequence number.

    Sequence numbers are normally assigned in the LogRecord constructor, so it should not normally be necessary to use this method.

 public  void setSourceClassName(String sourceClassName) 
    Set the name of the class that (allegedly) issued the logging request.
 public  void setSourceMethodName(String sourceMethodName) 
    Set the name of the method that (allegedly) issued the logging request.
 public  void setThreadID(int threadID) 
    Set an identifier for the thread where the message originated.
 public  void setThrown(Throwable thrown) 
    Set a throwable associated with the log event.