com.opencloud.slee.resources.cgin.callcontrol

Class CCMessageID.Text

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCMessageID.Text

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

CCMessageID

public static class CCMessageID.Text
extends AbstractFieldsObject

API for CC-DataTypes.MessageID.text. Generated from the following ASN.1 type definition and the adaptations below.

 text ::=
     SEQUENCE {
         messageContent IA5String,
         attributes     OCTET STRING OPTIONAL
     }
 CC-DataTypes {
     MessageID {
         text {
             attributes {
                 @extendible
             }
         }
     }
 }
 

Used as field type by CCMessageID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CCMessageID.Text.Attributes API for CC-DataTypes.MessageID.text.attributes.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
CCMessageID.Text() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CCMessageID.Text	clone() Constructs a copy of this object and everything reachable from it.
static CCMessageID.Text	copyOf(CCMessageID.Text from) Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
CCMessageID.Text.Attributes	getAttributes() Gets the value of the field attributes.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value.
String	getMessageContent() Gets the value of the field messageContent.
boolean	hasAttributes() Tests whether the field attributes has a value.
boolean	hasMessageContent() Tests whether the field messageContent has a value.
CCMessageID.Text	setAttributes(CCMessageID.Text.Attributes value) Sets the value of the field attributes.
CCMessageID.Text	setMessageContent(String value) Sets the value of the field messageContent.
void	setReadOnly() Sets this and all its fields to be immutable.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CCMessageID.Text

public CCMessageID.Text()

Constructs an object with uninitialised state.

Method Detail

clone

public CCMessageID.Text clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

public static CCMessageID.Text copyOf(CCMessageID.Text from)

Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.

Parameters:

from - the object from which to copy

Returns:

CCMessageID.Text

getAttributes

public CCMessageID.Text.Attributes getAttributes()

Gets the value of the field attributes.

Returns:

value of field attributes, or null if not present

getFieldAccessors

public static FieldAccessor[] getFieldAccessors()

Gets a new array of the accessors for fields of this type.

Returns:

FieldAccessor[]

getFieldsMap

public Map<String,Object> getFieldsMap(boolean withAbsents)

Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getMessageContent

public String getMessageContent()

Gets the value of the field messageContent.

Returns:

value of field messageContent, or null if not present

hasAttributes

public boolean hasAttributes()

Tests whether the field attributes has a value.

Returns:

whether the field attributes has a value

hasMessageContent

public boolean hasMessageContent()

Tests whether the field messageContent has a value.

Returns:

whether the field messageContent has a value

setAttributes

public CCMessageID.Text setAttributes(CCMessageID.Text.Attributes value)
                               throws IllegalStateException

Sets the value of the field attributes. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setMessageContent

public CCMessageID.Text setMessageContent(String value)
                                   throws IllegalStateException

Sets the value of the field messageContent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject