Package com.opencloud.slee.resources.cgin.map

Class MAPCodecList

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPCodecList

All Implemented Interfaces:

DataObject, Serializable

public class MAPCodecList
extends AbstractFieldsObject

API for MAP-MS-DataTypes.CodecList. Generated from the following ASN.1 type definition.

 CodecList ::=
     SEQUENCE {
         codec1             Codec,
         codec2             Codec OPTIONAL,
         codec3             Codec OPTIONAL,
         codec4             Codec OPTIONAL,
         codec5             Codec OPTIONAL,
         codec6             Codec OPTIONAL,
         codec7             Codec OPTIONAL,
         codec8             Codec OPTIONAL,
         extensionContainer ExtensionContainer OPTIONAL,
         ...
     }
 

Added in release 5. Codecs are sent in priority order, where codec1 has highest priority.

Used as field type by MAPSupportedCodecsList.

Used as field type by MAPSupportedCodecsList.

Used as field type by MAPPrepareHO_Res_v3.

Used as field type by MAPProcessAccessSignalling_Arg_v3.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
MAPCodecList()	Constructs an object with uninitialised state.

Method Summary

Modifier and Type	Method	Description
MAPCodecList	clone()	Constructs a copy of this object and everything reachable from it.
static MAPCodecList	copyOf(MAPCodecList 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.
byte[]	getCodec1()	Gets the value of the field codec1.
byte[]	getCodec2()	Gets the value of the field codec2.
byte[]	getCodec3()	Gets the value of the field codec3.
byte[]	getCodec4()	Gets the value of the field codec4.
byte[]	getCodec5()	Gets the value of the field codec5.
byte[]	getCodec6()	Gets the value of the field codec6.
byte[]	getCodec7()	Gets the value of the field codec7.
byte[]	getCodec8()	Gets the value of the field codec8.
MAPExtensionContainer	getExtensionContainer()	Gets the value of the field extensionContainer.
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.
boolean	hasCodec1()	Tests whether the field codec1 has a value.
boolean	hasCodec2()	Tests whether the field codec2 has a value.
boolean	hasCodec3()	Tests whether the field codec3 has a value.
boolean	hasCodec4()	Tests whether the field codec4 has a value.
boolean	hasCodec5()	Tests whether the field codec5 has a value.
boolean	hasCodec6()	Tests whether the field codec6 has a value.
boolean	hasCodec7()	Tests whether the field codec7 has a value.
boolean	hasCodec8()	Tests whether the field codec8 has a value.
boolean	hasExtensionContainer()	Tests whether the field extensionContainer has a value.
MAPCodecList	setCodec1(byte[] value)	Sets the value of the field codec1.
MAPCodecList	setCodec2(byte[] value)	Sets the value of the field codec2.
MAPCodecList	setCodec3(byte[] value)	Sets the value of the field codec3.
MAPCodecList	setCodec4(byte[] value)	Sets the value of the field codec4.
MAPCodecList	setCodec5(byte[] value)	Sets the value of the field codec5.
MAPCodecList	setCodec6(byte[] value)	Sets the value of the field codec6.
MAPCodecList	setCodec7(byte[] value)	Sets the value of the field codec7.
MAPCodecList	setCodec8(byte[] value)	Sets the value of the field codec8.
MAPCodecList	setExtensionContainer(MAPExtensionContainer value)	Sets the value of the field extensionContainer.
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

MAPCodecList

public MAPCodecList()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPCodecList

getCodec1

public byte[] getCodec1()

Gets the value of the field codec1.

Returns:

value of field codec1, or null if not present

getCodec2

public byte[] getCodec2()

Gets the value of the field codec2.

Returns:

value of field codec2, or null if not present

getCodec3

public byte[] getCodec3()

Gets the value of the field codec3.

Returns:

value of field codec3, or null if not present

getCodec4

public byte[] getCodec4()

Gets the value of the field codec4.

Returns:

value of field codec4, or null if not present

getCodec5

public byte[] getCodec5()

Gets the value of the field codec5.

Returns:

value of field codec5, or null if not present

getCodec6

public byte[] getCodec6()

Gets the value of the field codec6.

Returns:

value of field codec6, or null if not present

getCodec7

public byte[] getCodec7()

Gets the value of the field codec7.

Returns:

value of field codec7, or null if not present

getCodec8

public byte[] getCodec8()

Gets the value of the field codec8.

Returns:

value of field codec8, or null if not present

getExtensionContainer

public MAPExtensionContainer getExtensionContainer()

Gets the value of the field extensionContainer.

Returns:

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

hasCodec1

public boolean hasCodec1()

Tests whether the field codec1 has a value.

Returns:

whether the field codec1 has a value

hasCodec2

public boolean hasCodec2()

Tests whether the field codec2 has a value.

Returns:

whether the field codec2 has a value

hasCodec3

public boolean hasCodec3()

Tests whether the field codec3 has a value.

Returns:

whether the field codec3 has a value

hasCodec4

public boolean hasCodec4()

Tests whether the field codec4 has a value.

Returns:

whether the field codec4 has a value

hasCodec5

public boolean hasCodec5()

Tests whether the field codec5 has a value.

Returns:

whether the field codec5 has a value

hasCodec6

public boolean hasCodec6()

Tests whether the field codec6 has a value.

Returns:

whether the field codec6 has a value

hasCodec7

public boolean hasCodec7()

Tests whether the field codec7 has a value.

Returns:

whether the field codec7 has a value

hasCodec8

public boolean hasCodec8()

Tests whether the field codec8 has a value.

Returns:

whether the field codec8 has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

setCodec1

public MAPCodecList setCodec1(byte[] value)
                       throws IllegalStateException

Sets the value of the field codec1.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCodec2

public MAPCodecList setCodec2(byte[] value)
                       throws IllegalStateException

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

setCodec3

public MAPCodecList setCodec3(byte[] value)
                       throws IllegalStateException

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

setCodec4

public MAPCodecList setCodec4(byte[] value)
                       throws IllegalStateException

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

setCodec5

public MAPCodecList setCodec5(byte[] value)
                       throws IllegalStateException

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

setCodec6

public MAPCodecList setCodec6(byte[] value)
                       throws IllegalStateException

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

setCodec7

public MAPCodecList setCodec7(byte[] value)
                       throws IllegalStateException

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

setCodec8

public MAPCodecList setCodec8(byte[] value)
                       throws IllegalStateException

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

setExtensionContainer

public MAPCodecList setExtensionContainer(MAPExtensionContainer value)
                                   throws IllegalStateException

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