org.eclipse.tptp.logging.events.cbe.impl
Class MsgCatalogTokenImpl

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.impl.MsgCatalogTokenImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, MsgCatalogToken

public class MsgCatalogTokenImpl
extends java.lang.Object
implements MsgCatalogToken

Interface representing a MsgCatalogToken.

The following description is from the Common Base Event v1.0.1 specification entitled "Canonical Situation Data Format: The Common Base Event V1.0.1":

A string used as substitution value for resolving an internationalized message into formatted text.

See Also:

Serialized Form

Method Summary

java.lang.Object	clone() Return a cloned (copy by value) object of this object.
boolean	equals(java.lang.Object object) Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.
java.lang.String	getValue() Returns the value of the 'Value' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setValue(java.lang.String newValue) Sets the value of the ' Value' attribute.
java.lang.String	toString()
void	validate() Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getValue

public java.lang.String getValue()

Description copied from interface: MsgCatalogToken

Returns the value of the 'Value' attribute.

Specified by:

getValue in interface MsgCatalogToken

Returns:

the value of the 'Value' attribute.

See Also:

MsgCatalogToken.setValue(String)

setValue

public void setValue(java.lang.String newValue)

Description copied from interface: MsgCatalogToken

Sets the value of the ' Value' attribute.

The string length for value must not exceed 256 characters.

Specified by:

setValue in interface MsgCatalogToken

Parameters:

newValue - the new value of the 'Value' attribute.

See Also:

MsgCatalogToken.getValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.

Overrides:

equals in class java.lang.Object

Parameters:

object - The java.lang.Object to be compared to this object.

Returns:

True, if this object is the same as the parameter object, otherwise false.

See Also:

Object.equals(java.lang.Object)

validate

public void validate()
              throws ValidationException

Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Specified by:

validate in interface MsgCatalogToken

Throws:

ValidationException - If the event instance does not conform to the Common Base Event specification.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Return a cloned (copy by value) object of this object.

This is a deep copy version, in which all the objects within this object will be copied by value.

Overrides:

clone in class java.lang.Object

Returns:

Object The cloned (copy by value) object of this object.

Throws:

java.lang.CloneNotSupportedException - If a instance variable of this object does not implement the Cloneable interface.

init

public void init()

Resets the object's properties to their initial (e.g. null) state. All components are initialized to either zero or null.

Specified by:

init in interface MsgCatalogToken