com.waveset.msgcat
Class Message

java.lang.Object
  extended bycom.waveset.util.AbstractXmlObject
      extended bycom.waveset.msgcat.Message
All Implemented Interfaces:
javax.naming.Referenceable, XmlObject
Direct Known Subclasses:
ErrorMessage

public class Message
extends AbstractXmlObject

An object that encapsulates information necessary to format an internationalized message.


Field Summary
static java.lang.String ATT_CLASS
           
static java.lang.String ATT_ID
           
static java.lang.String ATT_OWNER
           
static java.lang.String ATT_TEXT
           
static java.lang.String ATTR_ID
          Attribute names for the packed version of the message
static java.lang.String ATTR_PARAMS
           
static java.lang.String code_id
           
static java.lang.String EL_OBJECT
           
static java.lang.String EL_TEXT
           
static java.lang.String EL_VALUE
           
static java.lang.String ELEMENT
           
 
Fields inherited from class com.waveset.util.AbstractXmlObject
_trace
 
Constructor Summary
Message(org.w3c.dom.Element e)
          Construct a messages from XML.
Message(java.lang.String id)
          Construct a message object with only an id.
Message(java.lang.String id, java.lang.Object parm1)
          Construct a message with an id and one parameter.
Message(java.lang.String id, java.lang.Object[] parameters)
          Construct a message with an id and parameters, but no default message.
Message(java.lang.String id, java.lang.Object parm1, java.lang.Object parm2)
          Construct a message with an id and two parameters.
Message(java.lang.String id, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3)
          Construct a message with an id and three parameters.
Message(java.lang.String id, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4)
          Construct a message with an id and four parameters.
Message(java.lang.String id, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4, java.lang.Object parm5)
          Construct a message with an id and five parameters.
Message(java.lang.String id, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4, java.lang.Object parm5, java.lang.Object parm6)
          Construct a message with an id and six parameters.
 
Method Summary
protected  void addSubclassAttributes(java.lang.StringBuffer b)
           
protected  void addSubclassElements(java.lang.StringBuffer b, int indent)
           
 boolean equals(java.lang.Object o)
          Determine equivalence.
 java.lang.String getElementName()
          Return the element name.
 java.lang.String getId()
          Get the unique id for this message.
 java.lang.String getMessage()
          Get a message in the default locale.
 java.lang.String getMessage(java.util.Locale locale)
          Get the message using a particular locale.
 java.lang.String getOwner()
           
 java.lang.Object[] getParameters()
          Get the message parameter list.
 int hashCode()
          Determine hash code.
protected  void parseSubclassAttributes(org.w3c.dom.Element e)
           
protected  void parseSubclassElements(org.w3c.dom.Element e)
           
 void parseXml(org.w3c.dom.Element e)
           
 void setOwner(java.lang.String owner)
           
 void setParameters(java.lang.Object[] parameters)
          Set the message parameter list.
 java.lang.String toString()
          Get the message in the default locale, should only be used for debugging.
 java.lang.String toString(java.util.Locale locale)
          Format the message in the given locale.
 java.lang.String toXml()
          Serialize this object as an XML string.
 void toXml(java.lang.StringBuffer b, int indent)
          Serialize this object as an XML string.
 
Methods inherited from class com.waveset.util.AbstractXmlObject
addXmlHeader, cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml, toXml
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT
See Also:
Constant Field Values

ATTR_ID

public static final java.lang.String ATTR_ID
Attribute names for the packed version of the message

See Also:
Constant Field Values

ATTR_PARAMS

public static final java.lang.String ATTR_PARAMS
See Also:
Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID
See Also:
Constant Field Values

ATT_TEXT

public static final java.lang.String ATT_TEXT
See Also:
Constant Field Values

ATT_OWNER

public static final java.lang.String ATT_OWNER
See Also:
Constant Field Values

EL_TEXT

public static final java.lang.String EL_TEXT
See Also:
Constant Field Values

EL_VALUE

public static final java.lang.String EL_VALUE
See Also:
Constant Field Values

EL_OBJECT

public static final java.lang.String EL_OBJECT
See Also:
Constant Field Values

ATT_CLASS

public static final java.lang.String ATT_CLASS
See Also:
Constant Field Values
Constructor Detail

Message

public Message(org.w3c.dom.Element e)
        throws WavesetException
Construct a messages from XML.


Message

public Message(java.lang.String id)
Construct a message object with only an id.

To ease the transition to catalogs, we will also allow this to be literal text, but applications should always eventually add a catalog entry.


Message

public Message(java.lang.String id,
               java.lang.Object[] parameters)
Construct a message with an id and parameters, but no default message.


Message

public Message(java.lang.String id,
               java.lang.Object parm1)
Construct a message with an id and one parameter. Convenience method for those that don't like building string arrays.


Message

public Message(java.lang.String id,
               java.lang.Object parm1,
               java.lang.Object parm2)
Construct a message with an id and two parameters. Convenience method for those that don't like building string arrays.


Message

public Message(java.lang.String id,
               java.lang.Object parm1,
               java.lang.Object parm2,
               java.lang.Object parm3)
Construct a message with an id and three parameters. Convenience method for those that don't like building string arrays.


Message

public Message(java.lang.String id,
               java.lang.Object parm1,
               java.lang.Object parm2,
               java.lang.Object parm3,
               java.lang.Object parm4)
Construct a message with an id and four parameters. Convenience method for those that don't like building string arrays.


Message

public Message(java.lang.String id,
               java.lang.Object parm1,
               java.lang.Object parm2,
               java.lang.Object parm3,
               java.lang.Object parm4,
               java.lang.Object parm5)
Construct a message with an id and five parameters. Convenience method for those that don't like building string arrays.


Message

public Message(java.lang.String id,
               java.lang.Object parm1,
               java.lang.Object parm2,
               java.lang.Object parm3,
               java.lang.Object parm4,
               java.lang.Object parm5,
               java.lang.Object parm6)
Construct a message with an id and six parameters. Convenience method for those that don't like building string arrays.

Method Detail

setOwner

public void setOwner(java.lang.String owner)

getElementName

public java.lang.String getElementName()
Description copied from class: AbstractXmlObject
Return the element name.

Specified by:
getElementName in interface XmlObject
Specified by:
getElementName in class AbstractXmlObject

getId

public java.lang.String getId()
Get the unique id for this message. Might be used to conditionally handle certain messages, but normally it is used only as a key into a message catalog.


getParameters

public java.lang.Object[] getParameters()
Get the message parameter list.


setParameters

public void setParameters(java.lang.Object[] parameters)
Set the message parameter list.


getMessage

public java.lang.String getMessage()
Get a message in the default locale. This should only be called to render debug messages, most code should be passing in a locale.


getMessage

public java.lang.String getMessage(java.util.Locale locale)
Get the message using a particular locale.


toString

public java.lang.String toString()
Get the message in the default locale, should only be used for debugging.


toString

public java.lang.String toString(java.util.Locale locale)
Format the message in the given locale.


getOwner

public java.lang.String getOwner()

addSubclassAttributes

protected void addSubclassAttributes(java.lang.StringBuffer b)

addSubclassElements

protected void addSubclassElements(java.lang.StringBuffer b,
                                   int indent)

parseSubclassAttributes

protected void parseSubclassAttributes(org.w3c.dom.Element e)
                                throws WavesetException
Throws:
WavesetException

parseSubclassElements

protected void parseSubclassElements(org.w3c.dom.Element e)
                              throws WavesetException
Throws:
WavesetException

toXml

public void toXml(java.lang.StringBuffer b,
                  int indent)
Serialize this object as an XML string.

Specified by:
toXml in interface XmlObject
Specified by:
toXml in class AbstractXmlObject

parseXml

public void parseXml(org.w3c.dom.Element e)
              throws WavesetException
Throws:
WavesetException

toXml

public java.lang.String toXml()
Serialize this object as an XML string.

Specified by:
toXml in interface XmlObject
Overrides:
toXml in class AbstractXmlObject

equals

public boolean equals(java.lang.Object o)
Determine equivalence. Used for testing.


hashCode

public int hashCode()
Determine hash code. Used for testing.