org.loom.i18n
Class Message

java.lang.Object
  org.loom.i18n.Message

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class Message
extends java.lang.Object
implements java.io.Externalizable

A message for the end user. Messages are translated according to message templates retrieved from a MessageRepository. Each message includes all the arguments needed for the translation, indicating whether it should be translated or not.

See Also:

Serialized Form

Field Summary

static java.lang.String	PROPERTY_PATH_ARG the property path
static java.lang.String	VALUE_ARG the value

Constructor Summary

Message()

Message(MessageLevel level, java.lang.String messageKey)

Message(MessageLevel level, java.lang.String messageKey, java.lang.String propertyPath)

Message(java.lang.String messageKey)

Message(java.lang.String messageKey, java.lang.String propertyPath)

Method Summary

Message	addArg(java.lang.String arg, java.lang.Object value)
Message	addTranslatedArg(java.lang.String arg, java.lang.Object value)
java.util.Map<java.lang.String,java.lang.Object>	getArgs()
MessageLevel	getLevel()
java.lang.String	getMessageKey()
java.lang.String	getPropertyPath()
java.lang.String	getSerializedValue()
java.util.Map<java.lang.String,java.lang.Object>	getTranslatedArgs()
boolean	isDeserialized()
boolean	isRendered()
void	readExternal(java.io.ObjectInput in)
void	setRendered(boolean rendered)
void	setSerializedValue(java.lang.String serializedValue)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PATH_ARG

public static final java.lang.String PROPERTY_PATH_ARG

the property path

See Also:

Constant Field Values

VALUE_ARG

public static final java.lang.String VALUE_ARG

the value

See Also:

Constant Field Values

Constructor Detail

Message

public Message()

Message

public Message(java.lang.String messageKey)

Message

public Message(java.lang.String messageKey,
               java.lang.String propertyPath)

Message

public Message(MessageLevel level,
               java.lang.String messageKey)

Message

public Message(MessageLevel level,
               java.lang.String messageKey,
               java.lang.String propertyPath)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getArgs

public java.util.Map<java.lang.String,java.lang.Object> getArgs()

getMessageKey

public java.lang.String getMessageKey()

getTranslatedArgs

public java.util.Map<java.lang.String,java.lang.Object> getTranslatedArgs()

getPropertyPath

public java.lang.String getPropertyPath()

addArg

public Message addArg(java.lang.String arg,
                      java.lang.Object value)

addTranslatedArg

public Message addTranslatedArg(java.lang.String arg,
                                java.lang.Object value)

isRendered

public boolean isRendered()

setRendered

public void setRendered(boolean rendered)

getLevel

public MessageLevel getLevel()

isDeserialized

public boolean isDeserialized()

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

getSerializedValue

public java.lang.String getSerializedValue()

setSerializedValue

public void setSerializedValue(java.lang.String serializedValue)