|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.logging.LogRecord
public class LogRecord
A LogRecord
contains the state for an individual
event to be logged.
As soon as a LogRecord instance has been handed over to the logging framework, applications should not manipulate it anymore.
Constructor Summary | |
---|---|
LogRecord(Level level,
String message)
Constructs a LogRecord given a severity level and
an unlocalized message text. |
Method Summary | |
---|---|
Level |
getLevel()
Returns the level of the LogRecord. |
String |
getLoggerName()
Returns the name of the logger where this LogRecord
has originated. |
String |
getMessage()
Returns the message for this LogRecord before
any localization or parameter substitution. |
long |
getMillis()
Returns the time when this LogRecord was created. |
Object[] |
getParameters()
Returns the parameters to the log message. |
ResourceBundle |
getResourceBundle()
Returns the resource bundle that is used when the message of this LogRecord needs to be localized. |
String |
getResourceBundleName()
Returns the name of the resource bundle that is used when the message of this LogRecord needs to be localized. |
long |
getSequenceNumber()
Returns the sequence number of this LogRecord . |
String |
getSourceClassName()
Returns the name of the class where the event being logged has had its origin. |
String |
getSourceMethodName()
Returns the name of the method where the event being logged has had its origin. |
int |
getThreadID()
Returns an identifier for the thread in which this LogRecord was created. |
Throwable |
getThrown()
Returns the Throwable associated with this LogRecord ,
or null if the logged event is not related to an exception
or error. |
void |
setLevel(Level level)
Sets the severity level of this LogRecord to a new
value. |
void |
setLoggerName(String name)
Sets the name of the logger where this LogRecord
has originated. |
void |
setMessage(String message)
Sets the message for this LogRecord . |
void |
setMillis(long millis)
Sets the time when this LogRecord was created. |
void |
setParameters(Object[] parameters)
Sets the parameters to the log message. |
void |
setResourceBundle(ResourceBundle bundle)
Sets the resource bundle that is used when the message of this LogRecord needs to be localized. |
void |
setResourceBundleName(String name)
Sets the name of the resource bundle that is used when the message of this LogRecord needs to be localized. |
void |
setSequenceNumber(long seqNum)
Sets the sequence number of this LogRecord to a new
value. |
void |
setSourceClassName(String sourceClassName)
Sets the name of the class where the event being logged has had its origin. |
void |
setSourceMethodName(String sourceMethodName)
Sets the name of the method where the event being logged has had its origin. |
void |
setThreadID(int threadID)
Sets the identifier indicating in which thread this LogRecord was created. |
void |
setThrown(Throwable thrown)
Associates this LogRecord with an exception or error. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LogRecord(Level level, String message)
LogRecord
given a severity level and
an unlocalized message text. In addition, the sequence number,
creation time (as returned by getMillis()
) and
thread ID are assigned. All other properties are set to
null
.
level
- the severity level, for example Level.WARNING
.message
- the message text (which will be used as key
for looking up the localized message text
if a resource bundle has been associated).Method Detail |
---|
public String getLoggerName()
LogRecord
has originated.
Logger
, or
null
if this LogRecord
does not originate from a Logger
.public void setLoggerName(String name)
LogRecord
has originated.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
name
- the name of the source logger, or null
to
indicate that this LogRecord
does not
originate from a Logger
.public ResourceBundle getResourceBundle()
LogRecord
needs to be localized.
null
if this message does not need
to be localized.public void setResourceBundle(ResourceBundle bundle)
LogRecord
needs to be localized.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
bundle
- the resource bundle to be used, or
null
to indicate that this
message does not need to be localized.public String getResourceBundleName()
LogRecord
needs to be localized.
null
if this message does not need
to be localized.public void setResourceBundleName(String name)
LogRecord
needs to be localized.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
name
- the name of the resource bundle to be used, or
null
to indicate that this message
does not need to be localized.public Level getLevel()
Applications should be aware of the possibility that the
result is not necessarily one of the standard logging levels,
since the logging framework allows to create custom subclasses
of java.util.logging.Level
. Therefore, filters
should perform checks like theRecord.getLevel().intValue()
== Level.INFO.intValue()
instead of theRecord.getLevel()
== Level.INFO
.
public void setLevel(Level level)
LogRecord
to a new
value.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
level
- the new severity level, for example
Level.WARNING
.public long getSequenceNumber()
LogRecord
.
public void setSequenceNumber(long seqNum)
LogRecord
to a new
value.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
seqNum
- the new sequence number.public String getSourceClassName()
null
if this information could not
be obtained.public void setSourceClassName(String sourceClassName)
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
sourceClassName
- the name of the class that issued the
logging request, or null
to indicate that
this information could not be obtained.public String getSourceMethodName()
null
if this information could not
be obtained.public void setSourceMethodName(String sourceMethodName)
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
sourceMethodName
- the name of the method that issued the
logging request, or null
to indicate that
this information could not be obtained.public String getMessage()
LogRecord
before
any localization or parameter substitution.
A Logger
will try to localize the message
if a resource bundle has been associated with this
LogRecord
. In this case, the logger will call
getMessage()
and use the result as the key
for looking up the localized message in the bundle.
If no bundle has been associated, or if the result of
getMessage()
is not a valid key in the
bundle, the logger will use the raw message text as
returned by this method.
null
if there
is no message text.public void setMessage(String message)
LogRecord
.
A Logger
will try to localize the message
if a resource bundle has been associated with this
LogRecord
. In this case, the logger will call
getMessage()
and use the result as the key
for looking up the localized message in the bundle.
If no bundle has been associated, or if the result of
getMessage()
is not a valid key in the
bundle, the logger will use the raw message text as
returned by this method.
It is possible to set the message to either an empty String or
null
, although this does not make the the message
very helpful to human users.
message
- the message text (which will be used as key
for looking up the localized message text
if a resource bundle has been associated).public Object[] getParameters()
null
if
the message has no parameters.public void setParameters(Object[] parameters)
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
parameters
- the parameters to the message, or null
to indicate that the message has no parameters.public int getThreadID()
LogRecord
was created. The identifier is not
necessarily related to any thread identifiers used by the
operating system.
public void setThreadID(int threadID)
LogRecord
was created. The identifier is not
necessarily related to any thread identifiers used by the
operating system.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
threadID
- the identifier for the source thread.public long getMillis()
LogRecord
was created.
public void setMillis(long millis)
LogRecord
was created.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
millis
- the time of creation in milliseconds since the
beginning of January 1, 1970.public Throwable getThrown()
LogRecord
,
or null
if the logged event is not related to an exception
or error.
public void setThrown(Throwable thrown)
LogRecord
with an exception or error.
As soon as a LogRecord
has been handed over
to the logging framework, applications should not modify it
anymore. Therefore, this method should only be called on
freshly constructed LogRecords.
thrown
- the exception or error to associate with, or
null
if this LogRecord
should be made unrelated to an exception or error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |