com.opencloud.slee.resources.cgin.cap_v4

Class CAP4AudibleIndicator

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4AudibleIndicator

All Implemented Interfaces:

DataObject, Serializable

public class CAP4AudibleIndicator
extends AbstractFieldsObject

API for CAP-datatypes.AudibleIndicator. Generated from the following ASN.1 type definition.

 AudibleIndicator ::=
     CHOICE {
         tone      BOOLEAN,
         burstList BurstList
     }
 

Used as field type by CAP4CAMEL_AChBillingChargingCharacteristics.TimeDurationCharging.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CAP4AudibleIndicator.Choice API for CAP-datatypes.AudibleIndicator.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
CAP4AudibleIndicator()

Method Summary

Methods

Modifier and Type	Method and Description
CAP4AudibleIndicator	clone() Constructs a copy of this object and everything reachable from it.
static CAP4AudibleIndicator	copyOf(CAP4AudibleIndicator 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.
CAP4BurstList	getBurstList() Gets the value of the burstList choice.
CAP4AudibleIndicator.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.
boolean	getTone() Gets the value of the tone choice.
boolean	isBurstListChosen() Tests whether the choice is burstList.
boolean	isToneChosen() Tests whether the choice is tone.
CAP4AudibleIndicator	setBurstList(CAP4BurstList value) Sets the value of the burstList choice.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4AudibleIndicator	setTone(boolean 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

CAP4AudibleIndicator

public CAP4AudibleIndicator()

Method Detail

clone

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

CAP4AudibleIndicator

getBurstList

public CAP4BurstList getBurstList()

Gets the value of the burstList choice.

Returns:

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

getChoice

public CAP4AudibleIndicator.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

getTone

public boolean getTone()
                throws IllegalStateException

Gets the value of the tone choice.

Returns:

value of the choice, if choice is tone

Throws:

IllegalStateException - if choice is not tone

isBurstListChosen

public boolean isBurstListChosen()

Tests whether the choice is burstList.

Returns:

true if chosen, false if not

isToneChosen

public boolean isToneChosen()

Tests whether the choice is tone.

Returns:

true if chosen, false if not

setBurstList

public CAP4AudibleIndicator setBurstList(CAP4BurstList value)
                                  throws IllegalStateException,
                                         NullPointerException

Sets the value of the burstList 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 CAP4AudibleIndicator setTone(boolean value)
                             throws IllegalStateException

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