Added in API level 1

LogRecord

open class LogRecord : Serializable

kotlin.Any
↳	java.util.logging.LogRecord

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:

• The LogRecord class is serializable.
• Because objects in the parameters array may not be serializable, during serialization all objects in the parameters array are written as the corresponding Strings (using Object.toString).
• The ResourceBundle is not transmitted as part of the serialized form, but the resource bundle name is, and the recipient object's readObject method will attempt to locate a suitable resource bundle.

Summary

Public constructors
LogRecord(level: Level!, msg: String!) Construct a LogRecord with the given level and message values.

Public methods
open Level!	getLevel() Get the logging message level, for example Level.
open String!	getLoggerName() Get the source Logger's name.
open String!	getMessage() Get the "raw" log message, before localization or formatting.
open Long	getMillis() Get event time in milliseconds since 1970.
open Array<Any!>!	getParameters() Get the parameters to the log message.
open ResourceBundle!	getResourceBundle() Get the localization resource bundle
open String!	getResourceBundleName() Get the localization resource bundle name
open Long	getSequenceNumber() Get the sequence number.
open String!	getSourceClassName() Get the name of the class that (allegedly) issued the logging request.
open String!	getSourceMethodName() Get the name of the method that (allegedly) issued the logging request.
open Int	getThreadID() Get an identifier for the thread where the message originated.
open Throwable!	getThrown() Get any throwable associated with the log record.
open Unit	setLevel(level: Level!) Set the logging message level, for example Level.
open Unit	setLoggerName(name: String!) Set the source Logger's name.
open Unit	setMessage(message: String!) Set the "raw" log message, before localization or formatting.
open Unit	setMillis(millis: Long) Set event time.
open Unit	setParameters(parameters: Array<Any!>!) Set the parameters to the log message.
open Unit	setResourceBundle(bundle: ResourceBundle!) Set the localization resource bundle.
open Unit	setResourceBundleName(name: String!) Set the localization resource bundle name.
open Unit	setSequenceNumber(seq: Long) Set the sequence number.
open Unit	setSourceClassName(sourceClassName: String!) Set the name of the class that (allegedly) issued the logging request.
open Unit	setSourceMethodName(sourceMethodName: String!) Set the name of the method that (allegedly) issued the logging request.
open Unit	setThreadID(threadID: Int) Set an identifier for the thread where the message originated.
open Unit	setThrown(thrown: Throwable!) Set a throwable associated with the log event.

Public constructors

LogRecord

Added in API level 1

LogRecord(
    level: Level!, 
    msg: String!)

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	Level!: a logging level value
msg	String!: the raw non-localized logging message (may be null)

Public methods

getLevel

Added in API level 1

open fun getLevel(): Level!

Get the logging message level, for example Level.SEVERE.

Return
Level!	the logging message level

getLoggerName

Added in API level 1

open fun getLoggerName(): String!

Get the source Logger's name.

Return
String!	source logger name (may be null)

getMessage

Added in API level 1

open fun getMessage(): String!

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.

Return
String!	the raw message string

getMillis

Added in API level 1

open fun getMillis(): Long

Get event time in milliseconds since 1970.

Return
Long	event time in millis since 1970

getParameters

Added in API level 1

open fun getParameters(): Array<Any!>!

Get the parameters to the log message.

Return
Array<Any!>!	the log message parameters. May be null if there are no parameters.

getResourceBundle

Added in API level 1

open fun getResourceBundle(): ResourceBundle!

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.

Return
ResourceBundle!	the localization resource bundle

getResourceBundleName

Added in API level 1

open fun getResourceBundleName(): String!

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.

Return
String!	the localization resource bundle name

getSequenceNumber

Added in API level 1

open fun getSequenceNumber(): Long

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.

Return
Long	the sequence number

getSourceClassName

Added in API level 1

open fun getSourceClassName(): String!

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.

Return
String!	the source class name

getSourceMethodName

Added in API level 1

open fun getSourceMethodName(): String!

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.

Return
String!	the source method name

getThreadID

Added in API level 1

open fun getThreadID(): Int

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.

Return
Int	thread ID

getThrown

Added in API level 1

open fun getThrown(): Throwable!

Get any throwable associated with the log record.

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

Return
Throwable!	a throwable

setLevel

Added in API level 1

open fun setLevel(level: Level!): Unit

Set the logging message level, for example Level.SEVERE.

Parameters
level	Level!: the logging message level

setLoggerName

Added in API level 1

open fun setLoggerName(name: String!): Unit

Set the source Logger's name.

Parameters
name	String!: the source logger name (may be null)

setMessage

Added in API level 1

open fun setMessage(message: String!): Unit

Set the "raw" log message, before localization or formatting.

Parameters
message	String!: the raw message string (may be null)

setMillis

Added in API level 1

open fun setMillis(millis: Long): Unit

Set event time.

Parameters
millis	Long: event time in millis since 1970

setParameters

Added in API level 1

open fun setParameters(parameters: Array<Any!>!): Unit

Set the parameters to the log message.

Parameters
parameters	Array<Any!>!: the log message parameters. (may be null)

setResourceBundle

Added in API level 1

open fun setResourceBundle(bundle: ResourceBundle!): Unit

Set the localization resource bundle.

Parameters
bundle	ResourceBundle!: localization bundle (may be null)

setResourceBundleName

Added in API level 1

open fun setResourceBundleName(name: String!): Unit

Set the localization resource bundle name.

Parameters
name	String!: localization bundle name (may be null)

setSequenceNumber

Added in API level 1

open fun setSequenceNumber(seq: Long): Unit

Set the sequence number.

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

Parameters
seq	Long: the sequence number

setSourceClassName

Added in API level 1

open fun setSourceClassName(sourceClassName: String!): Unit

Set the name of the class that (allegedly) issued the logging request.

Parameters
sourceClassName	String!: the source class name (may be null)

setSourceMethodName

Added in API level 1

open fun setSourceMethodName(sourceMethodName: String!): Unit

Set the name of the method that (allegedly) issued the logging request.

Parameters
sourceMethodName	String!: the source method name (may be null)

setThreadID

Added in API level 1

open fun setThreadID(threadID: Int): Unit

Set an identifier for the thread where the message originated.

Parameters
threadID	Int: the thread ID

setThrown

Added in API level 1

open fun setThrown(thrown: Throwable!): Unit

Set a throwable associated with the log event.

Parameters
thrown	Throwable!: a throwable (may be null)