org.safs.tools.logs

Class UniqueStringMessageInfo

java.lang.Object

org.safs.tools.UniqueStringID

org.safs.tools.logs.UniqueStringMessageInfo

All Implemented Interfaces:

UniqueMessageInterface, UniqueIDInterface

public class UniqueStringMessageInfo
extends UniqueStringID
implements UniqueMessageInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected java.lang.String	message
protected int	type

Fields inherited from class org.safs.tools.UniqueStringID

id

Constructor Summary

Constructors

Constructor and Description
UniqueStringMessageInfo() Constructor for UniqueStringMessageInfo
UniqueStringMessageInfo(java.lang.String id) Constructor for UniqueStringMessageInfo
UniqueStringMessageInfo(java.lang.String id, java.lang.String message, java.lang.String description, int type) PREFERRED Constructor for UniqueStringMessageInfo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogMessage() The message to log.
java.lang.String	getLogMessageDescription() Optional.
int	getLogMessageType() The type of the message to log.
void	setLogMessage(java.lang.String message) Set message to String provided.
void	setLogMessageDescription(java.lang.String description) Set message description to String provided.
void	setLogMessageType(int type) Set message type to that provided.

Methods inherited from class org.safs.tools.UniqueStringID

getStringID, getUniqueID, setStringID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.safs.tools.UniqueIDInterface

getUniqueID

Field Detail

message

protected java.lang.String message

description

protected java.lang.String description

type

protected int type

Constructor Detail

UniqueStringMessageInfo

public UniqueStringMessageInfo()

Constructor for UniqueStringMessageInfo

UniqueStringMessageInfo

public UniqueStringMessageInfo(java.lang.String id)

Constructor for UniqueStringMessageInfo

UniqueStringMessageInfo

public UniqueStringMessageInfo(java.lang.String id,
                               java.lang.String message,
                               java.lang.String description,
                               int type)

PREFERRED Constructor for UniqueStringMessageInfo

Method Detail

setLogMessage

public void setLogMessage(java.lang.String message)

Set message to String provided.

getLogMessage

public java.lang.String getLogMessage()

Description copied from interface: UniqueMessageInterface

The message to log.

Specified by:

getLogMessage in interface UniqueMessageInterface

See Also:

UniqueMessageInterface.getLogMessage()

setLogMessageDescription

public void setLogMessageDescription(java.lang.String description)

Set message description to String provided.

getLogMessageDescription

public java.lang.String getLogMessageDescription()

Description copied from interface: UniqueMessageInterface

Optional. Additional details associated with the message. In many logs, this appears as an additional descriptive line in log output. This may be null or an empty string, and should be ignored if it is such.

Specified by:

getLogMessageDescription in interface UniqueMessageInterface

See Also:

UniqueMessageInterface.getLogMessageDescription()

setLogMessageType

public void setLogMessageType(int type)

Set message type to that provided.

getLogMessageType

public int getLogMessageType()

Description copied from interface: UniqueMessageInterface

The type of the message to log. For example, a GENERIC message, a PASSED message, a FAILED message, etc.. This may be implementation specific.

Specified by:

getLogMessageType in interface UniqueMessageInterface

See Also:

UniqueMessageInterface.getLogMessageType()