com.sap.tc.logging.interfaces

Interface ILogRecord

public interface ILogRecord

Method Summary

List	getArgObjs() Gets the argument objects of the template-based message belonging to this log record.
List	getArgs() Gets the toString results of the argument objects of the template-based message belonging to this log record.
com.sap.tc.logging.GUId	getGroupId() Gets the identification of the group.
int	getGroupIndent() Gets the indentation of nested groups.
int	getGroupLevel() Gets the level of nested groups.
com.sap.tc.logging.GUId	getId() Gets the message identification of this log record.
String	getLocationName() Gets the name of the location the message belonging to this log record came from.
String	getMsgClear() Gets the clear text version of this log record.
String	getMsgCode() Gets the toString result of the language-independent message code of this log record.
int	getMsgType() Gets the type of the message text of this log record.
String	getResourceBundleName() Gets the name of the resource bundle assigned to the language-independent message belonging to this log record.
int	getSeverity() Gets the severity of this log record.
LogController	getSource() Gets the log controller this log record came from.
String	getSourceName() Gets the name of the log controller this log record came from.
Thread	getThread() Gets the thread this log record belongs to if it still runs.
String	getThreadName() Gets the name of the thread this log record belongs to
Date	getTime() Gets the instantiation date of this log record in milliseconds.
boolean	isGroupActive() Gets the level of nested groups.

Method Detail

getId

public com.sap.tc.logging.GUId getId()

Gets the message identification of this log record. This identification is written to logs via most formatters and allows for unambiguous cross-referencing among messages in different logs.

Returns:

Unique message id

getTime

public Date getTime()

Gets the instantiation date of this log record in milliseconds.

Returns:

Instantiation date in milliseconds

getSource

public LogController getSource()

Gets the log controller this log record came from.

Returns:

Log controller

getSourceName

public String getSourceName()

Gets the name of the log controller this log record came from.

Returns:

Name of log controller

getLocationName

public String getLocationName()

Gets the name of the location the message belonging to this log record came from.

Returns:

Name of location

getThread

public Thread getThread()

Gets the thread this log record belongs to if it still runs.

Returns:

Thread, or null if meanwhile the thread terminated

getThreadName

public String getThreadName()

Gets the name of the thread this log record belongs to

Returns:

Name of the thread

getSeverity

public int getSeverity()

Gets the severity of this log record.

Returns:

Severity

getMsgType

public int getMsgType()

Gets the type of the message text of this log record.

Returns:

Type of message text

getMsgCode

public String getMsgCode()

Gets the toString result of the language-independent message code of this log record.

Returns:

Code of language-independent message

getMsgClear

public String getMsgClear()

Gets the clear text version of this log record.

Returns:

Clear text version

getResourceBundleName

public String getResourceBundleName()

Gets the name of the resource bundle assigned to the language-independent message belonging to this log record.

Returns:

Name of resource bundle

getArgs

public List getArgs()

Gets the toString results of the argument objects of the template-based message belonging to this log record.

Returns:

Unmodifiable list of message argument strings

getArgObjs

public List getArgObjs()

Gets the argument objects of the template-based message belonging to this log record. Please note that there are no defensive copies made of these objects, so all modifications made after generating this log record are reflected in the result of this method.

Returns:

Unmodifiable list of message argument objects

getGroupId

public com.sap.tc.logging.GUId getGroupId()

Gets the identification of the group.

Returns:

Unique top group id

isGroupActive

public boolean isGroupActive()

Gets the level of nested groups.

Returns:

Level of nested groups

getGroupLevel

public int getGroupLevel()

Gets the level of nested groups.

Returns:

Level of nested groups

getGroupIndent

public int getGroupIndent()

Gets the indentation of nested groups. This is the level

Returns:

Indentation of nested groups