no.g9.message

Class Message

java.lang.Object

no.g9.message.Message

All Implemented Interfaces:

Serializable, CLogLevels

public class Message
extends Object
implements CLogLevels, Serializable

A Message represents all the data in a message.

See Also:

Serialized Form

Field Summary

Fields inherited from interface no.g9.message.CLogLevels

LOG_CENTRAL, LOG_DEFAULT, LOG_INTERACTIVE, LOG_LOCAL, LOG_OPERATOR, LOG_SCREAM

Constructor Summary

Constructors

Constructor and Description
Message() Default constructor for Message.
Message(String messageID) Constructor with message id.
Message(String messageID, MessageType messageType, Object... args) Constructor with message number and type.
Message(String messageID, Object... args) Constructor with message id and arguments.

Method Summary

Modifier and Type	Method and Description
void	addDescription(String txt) Adds another descriptive string.
void	addMessage(Message that) Adds information from another message into this.
void	clearDescription() Clears all texts.
void	copy(Message that) Copies information from another message into this message.
Object[]	getArgs() Returns the message arguments.
MessageContext	getContext()
String	getDescription(int index) Returns one of the description texts.
String	getDescription(String delimiter) Returns all the description texts.
Throwable	getException() Returns the stored exception (if any).
String	getHint() Returns the hint.
long	getLogLevel() Returns the log level as a LOG_xxx-constant.
String	getMessageID() Returns the message number.
List<Message>	getMessages() Gets the messages contained by this message.
String	getMessageText() Returns the main message text.
MessageType	getMsgType() Returns the message type as a MSGTYPE_xxx-constant.
String	getReplString() Returns the reply String.
MessageReplyType	getReply() Returns the selected reply as a REPLY_xxx-constant.
File	getReplyFile() Getter for the property replyFile.
String	getRuntimeId() Returns the runtime ID (message identifier).
Severity	getSeverity() Getter for the severity property.
String	getTitle() Returns the title.
ReplySetType	getValidReplies() Returns a REPLSET_xxx-constant for the valid replies to this message.
static boolean	isEmpty(String s) Convenience method, checks if the specified String is either empty (""), or consists entirely of blanks (" "), or is a null-pointer, in which case it returns true
void	setArgs(Object[] pArgs) Sets the message arguments.
void	setContext(MessageContext context) Set the new message context.
void	setDescription(int index, MessageText txt) Sets new value of one of the texts.
void	setDescription(int index, String txt) Sets new value of one of the texts - to a fixed String.
void	setException(Throwable exc) Stores an exception.
void	setHint(String pHint) Set new value of hint (tool tip, status bar etc).
void	setLogLevel(long pLogLevel) Sets new log level.
void	setMessageID(String messageID) Sets the message number.
void	setMessageText(String pMessageText) Set new main message text.
void	setMsgType(MessageType pMsgType) Sets the message type.
void	setReplString(String newRepl) Sets the new string reply.
void	setReply(MessageReplyType pRepl) Sets the actual reply.
void	setReplyFile(File replyFile) Sets the new value for replyFile.
void	setSeverity(Severity severity) Setter for the severity property.
void	setTitle(String pTitle) Set new value of title.
void	setValidReplies(ReplySetType pReplies) Sets valid replies for this message.
String	toString() Returns a String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Default constructor for Message.

Message

public Message(String messageID)

Constructor with message id.

Parameters:

messageID - Message identificator

Message

public Message(String messageID,
               Object... args)

Constructor with message id and arguments.

Parameters:

messageID - Message identificator

args - message arguments

Message

public Message(String messageID,
               MessageType messageType,
               Object... args)

Constructor with message number and type.

Parameters:

messageID - Message id

args - message arguments

messageType - Message type (MSGTYPE_xxx-constant)

Method Detail

toString

public String toString()

Returns a String representation of this object.

Overrides:

toString in class Object

Returns:

This object as a String.

getRuntimeId

public String getRuntimeId()

Returns the runtime ID (message identifier).

Returns:

The runtime ID.

setMessageID

public void setMessageID(String messageID)

Sets the message number.

Parameters:

messageID - New value of MessageID.

See Also:

getMessageID()

getMessageID

public String getMessageID()

Returns the message number.

Returns:

Message number.

See Also:

setMessageID(String)

setArgs

public void setArgs(Object[] pArgs)

Sets the message arguments.

Parameters:

pArgs - New value of args.

See Also:

getArgs()

getArgs

public Object[] getArgs()

Returns the message arguments.

Returns:

Message arguments.

See Also:

setArgs(Object[])

setValidReplies

public void setValidReplies(ReplySetType pReplies)

Sets valid replies for this message.

Parameters:

pReplies - A REPLSET_xxx-constant for reply set.

See Also:

getValidReplies()

getValidReplies

public ReplySetType getValidReplies()

Returns a REPLSET_xxx-constant for the valid replies to this message.

Returns:

REPLSET_xxx-constant.

See Also:

setValidReplies(ReplySetType)

setReply

public void setReply(MessageReplyType pRepl)

Sets the actual reply.

Parameters:

pRepl - Selected reply as a REPLY_xxx-constant.

See Also:

getReply()

getReply

public MessageReplyType getReply()

Returns the selected reply as a REPLY_xxx-constant.

Returns:

The reply as a REPLY_xxx-constant.

See Also:

setReply(MessageReplyType)

setMsgType

public void setMsgType(MessageType pMsgType)

Sets the message type.

Parameters:

pMsgType - Message type as a MSGTYPE_xxx-constant..

See Also:

getMsgType()

getMsgType

public MessageType getMsgType()

Returns the message type as a MSGTYPE_xxx-constant.

Returns:

The message type as a MSGTYPE_xxx-constant.

See Also:

setMsgType(MessageType)

setLogLevel

public void setLogLevel(long pLogLevel)

Sets new log level.

Parameters:

pLogLevel - New log level as a LOG_xxx-constant.

See Also:

getLogLevel()

getLogLevel

public long getLogLevel()

Returns the log level as a LOG_xxx-constant.

Returns:

The log level as a LOG_xxx-constant.

See Also:

setLogLevel(long)

setDescription

public void setDescription(int index,
                           MessageText txt)

Sets new value of one of the texts.

Parameters:

index - Index of the text to set. Must be >=0. If the index creates a "hole" in the array, empty strings are added in between.

txt - The text to store.

Throws:

IndexOutOfBoundsException - If index is negative

See Also:

getDescription(int), setDescription(int, String)

setDescription

public void setDescription(int index,
                           String txt)

Sets new value of one of the texts - to a fixed String.

Parameters:

index - Index of the text to set. Must be >=0. If the index creates a "hole" in the array, empty strings are added in between.

txt - The text to store.

Throws:

IndexOutOfBoundsException - If index is negative

See Also:

getDescription(int), setDescription(int, MessageText), addDescription(String)

addDescription

public void addDescription(String txt)

Adds another descriptive string.

Parameters:

txt - The text to add.

See Also:

getDescription(int), setDescription(int, String)

clearDescription

public void clearDescription()

Clears all texts.

See Also:

setDescription(int, MessageText)

getDescription

public String getDescription(int index)

Returns one of the description texts.

Parameters:

index - Index of the text to get. Must be >=0. Returns an empty text if this index is not set.

Returns:

The text.

Throws:

IndexOutOfBoundsException - If index is negative

See Also:

setDescription(int, MessageText)

getDescription

public String getDescription(String delimiter)

Returns all the description texts.

Parameters:

delimiter - Inserted beween all elements. May be null.

Returns:

The text.

See Also:

getDescription(int)

addMessage

public void addMessage(Message that)

Adds information from another message into this.

Parameters:

that - Message to copy from

copy

public void copy(Message that)

Copies information from another message into this message. Most fields are copied only if the original field is empty. Exceptions: logLevel is combined (bitwise), and all description fields are added.

Parameters:

that - Message to copy from

isEmpty

public static boolean isEmpty(String s)

Convenience method, checks if the specified String is either empty (""), or consists entirely of blanks (" "), or is a null-pointer, in which case it returns true

Parameters:

s - the string to check

Returns:

Returns true if the string is either empty or null

setTitle

public void setTitle(String pTitle)

Set new value of title.

Parameters:

pTitle - New value of title.

See Also:

getTitle()

getTitle

public String getTitle()

Returns the title.

Returns:

The title.

See Also:

setTitle(String)

setMessageText

public void setMessageText(String pMessageText)

Set new main message text.

Parameters:

pMessageText - New main text.

See Also:

getMessageText()

getMessageText

public String getMessageText()

Returns the main message text. Never null.

Returns:

The main text.

See Also:

setMessageText(String)

setHint

public void setHint(String pHint)

Set new value of hint (tool tip, status bar etc).

Parameters:

pHint - New value of hint.

See Also:

getHint()

getHint

public String getHint()

Returns the hint.

Returns:

The hint.

See Also:

setHint(String)

setException

public void setException(Throwable exc)

Stores an exception.

Parameters:

exc - Last exception thrown.

See Also:

getException()

getException

public Throwable getException()

Returns the stored exception (if any).

Returns:

The stored exception (if any).

See Also:

setException(Throwable)

getContext

public MessageContext getContext()

Returns:

The current message context.

setContext

public void setContext(MessageContext context)

Set the new message context.

Parameters:

context - The new context.

setReplString

public void setReplString(String newRepl)

Sets the new string reply. Ensures it is never null.

Parameters:

newRepl - New reply string.

See Also:

getReplString()

getReplString

public String getReplString()

Returns the reply String.

Returns:

The reply string.

See Also:

setReplString(String)

getReplyFile

public File getReplyFile()

Getter for the property replyFile.

Returns:

The value of replyFile.

See Also:

setReplyFile(File)

setReplyFile

public void setReplyFile(File replyFile)

Sets the new value for replyFile.

Parameters:

replyFile - The new value for replyFile.

See Also:

getReplyFile()

setSeverity

public void setSeverity(Severity severity)

Setter for the severity property.

Parameters:

severity - The severity to set

getSeverity

public Severity getSeverity()

Getter for the severity property.

Returns:

The severity

getMessages

public List<Message> getMessages()

Gets the messages contained by this message.

Returns:

The list of messages