com.opencloud.slee.resources.cgin.cap_v4

Class CAP4BurstList

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4BurstList

All Implemented Interfaces:

DataObject, Serializable

public class CAP4BurstList
extends AbstractFieldsObject

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

 BurstList ::=
     SEQUENCE {
         warningPeriod INTEGER (1..1200) DEFAULT 30,
         bursts        Burst,
         ...
     }
 

Used as field type by CAP4AudibleIndicator.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4BurstList	clone() Constructs a copy of this object and everything reachable from it.
static CAP4BurstList	copyOf(CAP4BurstList 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.
CAP4Burst	getBursts() Gets the value of the field bursts.
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.
int	getWarningPeriod() Gets the value of the field warningPeriod.
boolean	hasBursts() Tests whether the field bursts has a value.
boolean	hasWarningPeriod() Tests whether the field warningPeriod has a value.
CAP4BurstList	setBursts(CAP4Burst value) Sets the value of the field bursts.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4BurstList	setWarningPeriod(int value) Sets the value of the field warningPeriod and marks the field as present.
CAP4BurstList	setWarningPeriodPresent(boolean flag) Sets the presence or absence of the optional field warningPeriod.

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

CAP4BurstList

public CAP4BurstList()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4BurstList

getBursts

public CAP4Burst getBursts()

Gets the value of the field bursts.

Returns:

value of field bursts, 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

getWarningPeriod

public int getWarningPeriod()

Gets the value of the field warningPeriod.

Returns:

value of field warningPeriod

hasBursts

public boolean hasBursts()

Tests whether the field bursts has a value.

Returns:

whether the field bursts has a value

hasWarningPeriod

public boolean hasWarningPeriod()

Tests whether the field warningPeriod has a value.

Returns:

whether the field warningPeriod has a value

setBursts

public CAP4BurstList setBursts(CAP4Burst value)
                        throws IllegalStateException

Sets the value of the field bursts.

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

setWarningPeriod

public CAP4BurstList setWarningPeriod(int value)
                               throws IllegalStateException

Sets the value of the field warningPeriod and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setWarningPeriodPresent

public CAP4BurstList setWarningPeriodPresent(boolean flag)
                                      throws IllegalStateException

Sets the presence or absence of the optional field warningPeriod.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

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