Package com.opencloud.slee.resources.cgin.callcontrol

Class CCInformationToSend

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInformationToSend

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CS1InformationToSend

public class CCInformationToSend
extends AbstractFieldsObject

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

 InformationToSend ::=
     CHOICE {
         inbandInfo InbandInfo,
         tone       Tone
     }
 CC-DataTypes {
     InformationToSend {
         @extendible
     }
 }
 

Used as field type by CCGapTreatment.

Used as field type by CCPromptAndCollectUserInformationArg.

Used as field type by CCPlayAnnouncementArg.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CCInformationToSend.Choice	API for CC-DataTypes.InformationToSend.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CCInformationToSend()

Method Summary

Modifier and Type	Method	Description
CCInformationToSend	clone()	Constructs a copy of this object and everything reachable from it.
static CCInformationToSend	copyOf(CCInformationToSend 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.
CCInformationToSend.Choice	getChoice()	Gets the discriminant of the current choice.
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 :discriminant-name to associated-value.
CCInbandInfo	getInbandInfo()	Gets the value of the inbandInfo choice.
CCTone	getTone()	Gets the value of the tone choice.
boolean	isInbandInfoChosen()	Tests whether the choice is inbandInfo.
boolean	isToneChosen()	Tests whether the choice is tone.
protected void	setChoice(CCInformationToSend.Choice arg)	Sets the discriminant of the current choice.
CCInformationToSend	setInbandInfo(CCInbandInfo value)	Sets the value of the inbandInfo choice.
void	setReadOnly()	Sets this and all its fields to be immutable.
CCInformationToSend	setTone(CCTone value)	Sets the value of the tone choice.

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

CCInformationToSend

public CCInformationToSend()

Method Detail

clone

public CCInformationToSend 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 CCInformationToSend copyOf(CCInformationToSend 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:

CCInformationToSend

getChoice

public CCInformationToSend.Choice getChoice()

Gets the discriminant of the current choice.

Returns:

the current discriminant

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 :discriminant-name to associated-value. For a value of primitive type, the value is boxed. If choice is not set, returns a map from : to AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - ignored, as value cannot be optional

Returns:

Map from :discriminant-name to associated-value

getInbandInfo

public CCInbandInfo getInbandInfo()

Gets the value of the inbandInfo choice.

Returns:

value of the choice, if choice is inbandInfo, else null

getTone

public CCTone getTone()

Gets the value of the tone choice.

Returns:

value of the choice, if choice is tone, else null

isInbandInfoChosen

public boolean isInbandInfoChosen()

Tests whether the choice is inbandInfo.

Returns:

true if chosen, false if not

isToneChosen

public boolean isToneChosen()

Tests whether the choice is tone.

Returns:

true if chosen, false if not

setChoice

protected void setChoice(CCInformationToSend.Choice arg)

Sets the discriminant of the current choice.

Parameters:

arg - the new discriminant

setInbandInfo

public CCInformationToSend setInbandInfo(CCInbandInfo value)
                                  throws IllegalStateException,
                                         NullPointerException

Sets the value of the inbandInfo choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setTone

public CCInformationToSend setTone(CCTone value)
                            throws IllegalStateException,
                                   NullPointerException

Sets the value of the tone choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null