com.opencloud.slee.resources.cgin.cap_v1

Class CAP1ExtensionField

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP1ExtensionField

All Implemented Interfaces:

DataObject, Serializable

public class CAP1ExtensionField
extends AbstractFieldsObject

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

 ExtensionField ::=
     SEQUENCE {
         type        Code,
         criticality CriticalityType,
         value       OpenType
     }
 CAP-DataTypes {
     ExtensionField {
         criticality {
             @forceOptional
         }
     }
 }
 

Used in array as field type by CAP1EventReportBCSMArg.

Used in array as field type by CAP1InitialDPArg.

Used in array as field type by CAP1RequestReportBCSMEventArg.

Used in array as field type by CAP1ConnectArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP1ExtensionField	clone() Constructs a copy of this object and everything reachable from it.
static CAP1ExtensionField	copyOf(CAP1ExtensionField 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.
CAP1CriticalityType	getCriticality() Gets the value of the field criticality.
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.
OpenId	getType() Gets the value of the field type.
ContainingOctetString	getValue() Gets the value of the field value.
boolean	hasCriticality() Tests whether the field criticality has a value.
boolean	hasType() Tests whether the field type has a value.
boolean	hasValue() Tests whether the field value has a value.
CAP1ExtensionField	setCriticality(CAP1CriticalityType value) Sets the value of the field criticality.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP1ExtensionField	setType(OpenId value) Sets the value of the field type.
CAP1ExtensionField	setValue(ContainingOctetString value) Sets the value of the field value.

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

CAP1ExtensionField

public CAP1ExtensionField()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP1ExtensionField

getCriticality

public CAP1CriticalityType getCriticality()

Gets the value of the field criticality.

Returns:

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

getType

public OpenId getType()

Gets the value of the field type.

Returns:

value of field type, or null if not present

getValue

public ContainingOctetString getValue()

Gets the value of the field value.

Returns:

value of field value, or null if not present

hasCriticality

public boolean hasCriticality()

Tests whether the field criticality has a value.

Returns:

whether the field criticality has a value

hasType

public boolean hasType()

Tests whether the field type has a value.

Returns:

whether the field type has a value

hasValue

public boolean hasValue()

Tests whether the field value has a value.

Returns:

whether the field value has a value

setCriticality

public CAP1ExtensionField setCriticality(CAP1CriticalityType value)
                                  throws IllegalStateException

Sets the value of the field criticality. 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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setType

public CAP1ExtensionField setType(OpenId value)
                           throws IllegalStateException

Sets the value of the field type.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setValue

public CAP1ExtensionField setValue(ContainingOctetString value)
                            throws IllegalStateException

Sets the value of the field value.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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