Package com.opencloud.slee.resources.in.datatypes.cc

Class MSBearerCapability.GSM.Content.NonSpeech.DataProtocol

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.cc.MSBearerCapability.GSM.Content.NonSpeech.DataProtocol

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

MSBearerCapability.GSM.Content.NonSpeech

public static final class MSBearerCapability.GSM.Content.NonSpeech.DataProtocol
extends AbstractLazyEncodedByteArray

Class DataProtocol represents the non-speech coding of data within a MSBearerCapability. It represents part of a larger octet string; it is not transmitted on a network by itself.

The API offered by this class is as if the type were specified in ASN.1 as follows.

 DataProtocol ::= SEQUENCE {
     establishment Establishment,
     nirr          NIRR,
     configuration Configuration,
     duplexMode    DuplexMode,
     structure     Structure,
     compression   Compression
 }

The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below.

Data Encoding -based on 3GPP TS 24.008 v4.17.0 (2007-09) §10.5.4.5 pp343-361
	8	7	6	5	4	3	2	1
Octet 4*	ext. 1	Compression	Structure		Duplex mode	Configuration	NIRR	Establishment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression	Enumeration DataProtocol Compression constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration	DataProtocol Configuration constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode	Enumeration DataProtocol Duplex Mode constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment	DataProtocol Establishment constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR	DataProtocol Negotiation of Intermediate Rate Requested constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure	DataProtocol Structure constants.

Field Summary

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
DataProtocol()	Constructs a new DataProtocol object with no fields set.
DataProtocol(byte[] data)	Constructs a new DataProtocol object from network-encoded data.
DataProtocol(byte[] data, int start, int len)	Constructs a new DataProtocol object from part of network-encoded data.
DataProtocol(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment establishment, MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR nIRR, MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration configuration, MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode duplexMode, MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure structure, MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression compression)	Constructs a new DataProtocol object from given values for all fields.
DataProtocol(DataInput in)	Constructs a new DataProtocol object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Modifier and Type	Method	Description
void	checkFieldsSet()	Checks that all mandatory fields are present.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	clone()	Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	copyOf(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol 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.
protected void	decode()	Computes the decoded form from the encoded form.
protected void	encode()	Computes the encoded form from the decoded form.
protected boolean	encodedIsInvalid()	Determines whether the encoded form is invalid.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression	getCompression()	Gets the value of the compression.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration	getConfiguration()	Gets the value of the configuration.
static int	getContainedLength(byte[] data, int start, int len)	Determines the length of the encoded value that commences at offset start in the given data.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode	getDuplexMode()	Gets the value of the duplex mode.
byte[]	getEncodedForm()	Gets the encoded form.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment	getEstablishment()	Gets the value of the establishment.
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 for the fields of a sequence.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR	getNIRR()	Gets the value of the NIRR.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure	getStructure()	Gets the value of the structure.
boolean	hasCompression()	Tests whether the field Compression has a value.
boolean	hasConfiguration()	Tests whether the field Configuration has a value.
boolean	hasDuplexMode()	Tests whether the field DuplexMode has a value.
boolean	hasEstablishment()	Tests whether the field Establishment has a value.
boolean	hasNIRR()	Tests whether the field NIRR has a value.
boolean	hasStructure()	Tests whether the field Structure has a value.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setCompression(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression value)	Sets the value of the compression.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setConfiguration(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration value)	Sets the value of the configuration.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setDuplexMode(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode value)	Sets the value of the duplex mode.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setEstablishment(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment value)	Sets the value of the establishment.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setNIRR(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR value)	Sets the value of the NIRR.
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol	setStructure(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure value)	Sets the value of the structure.
void	toStream(DataOutput out)	Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(DataInput)}.

Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataProtocol

public DataProtocol()

Constructs a new DataProtocol object with no fields set.

DataProtocol

public DataProtocol(byte[] data)

Constructs a new DataProtocol object from network-encoded data. The data is not decoded and might not be decodable.

Parameters:

data - network-encoded data

Throws:

NullPointerException - if data is null

DataProtocol

public DataProtocol(byte[] data,
                    int start,
                    int len)

Constructs a new DataProtocol object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.

Parameters:

data - network-encoded data

start - starting offset of network-encoded data in byte array

len - default length if not predictable

Throws:

NullPointerException - if data is null

IllegalArgumentException - if len is negative

DataProtocol

public DataProtocol(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment establishment,
                    MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR nIRR,
                    MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration configuration,
                    MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode duplexMode,
                    MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure structure,
                    MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression compression)

Constructs a new DataProtocol object from given values for all fields.

Parameters:

establishment - the establishment

nIRR - the NIRR

configuration - the configuration

duplexMode - the duplex mode

structure - the structure

compression - the compression

DataProtocol

public DataProtocol(DataInput in)
             throws IOException

Constructs a new DataProtocol object from data deserialized from a stream that was written by toStream(DataOutput).

Parameters:

in - the stream to read from

Throws:

EOFException - if reading is pre-empted by end-of-file

IOException - if the data cannot be read

Method Detail

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(DataInput)}.

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasEstablishment

public boolean hasEstablishment()
                         throws DecodeException

Tests whether the field Establishment has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasNIRR

public boolean hasNIRR()
                throws DecodeException

Tests whether the field NIRR has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasConfiguration

public boolean hasConfiguration()
                         throws DecodeException

Tests whether the field Configuration has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasDuplexMode

public boolean hasDuplexMode()
                      throws DecodeException

Tests whether the field DuplexMode has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasStructure

public boolean hasStructure()
                     throws DecodeException

Tests whether the field Structure has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasCompression

public boolean hasCompression()
                       throws DecodeException

Tests whether the field Compression has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

checkFieldsSet

public void checkFieldsSet()
                    throws EncodeException

Checks that all mandatory fields are present. Should be called immediately before all calls to encode().

Specified by:

checkFieldsSet in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if any mandatory field is not present

getEstablishment

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment getEstablishment()
                                                                                     throws DecodeException

Gets the value of the establishment.

Returns:

Establishment representation of the establishment

Throws:

DecodeException - if encoded state cannot be decoded

getNIRR

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR getNIRR()
                                                                   throws DecodeException

Gets the value of the NIRR.

Returns:

NIRR representation of the NIRR

Throws:

DecodeException - if encoded state cannot be decoded

getConfiguration

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration getConfiguration()
                                                                                     throws DecodeException

Gets the value of the configuration.

Returns:

Configuration representation of the configuration

Throws:

DecodeException - if encoded state cannot be decoded

getDuplexMode

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode getDuplexMode()
                                                                               throws DecodeException

Gets the value of the duplex mode.

Returns:

DuplexMode representation of the duplex mode

Throws:

DecodeException - if encoded state cannot be decoded

getStructure

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure getStructure()
                                                                             throws DecodeException

Gets the value of the structure.

Returns:

Structure representation of the structure

Throws:

DecodeException - if encoded state cannot be decoded

getCompression

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression getCompression()
                                                                                 throws DecodeException

Gets the value of the compression.

Returns:

Compression representation of the compression

Throws:

DecodeException - if encoded state cannot be decoded

setEstablishment

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setEstablishment(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment value)
                                                                       throws IllegalStateException

Sets the value of the establishment.

Parameters:

value - Establishment representation of the establishment

Returns:

this

Throws:

IllegalStateException

setNIRR

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setNIRR(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR value)
                                                              throws IllegalStateException

Sets the value of the NIRR.

Parameters:

value - NIRR representation of the NIRR

Returns:

this

Throws:

IllegalStateException

setConfiguration

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setConfiguration(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration value)
                                                                       throws IllegalStateException

Sets the value of the configuration.

Parameters:

value - Configuration representation of the configuration

Returns:

this

Throws:

IllegalStateException

setDuplexMode

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setDuplexMode(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode value)
                                                                    throws IllegalStateException

Sets the value of the duplex mode.

Parameters:

value - DuplexMode representation of the duplex mode

Returns:

this

Throws:

IllegalStateException

setStructure

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setStructure(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure value)
                                                                   throws IllegalStateException

Sets the value of the structure.

Parameters:

value - Structure representation of the structure

Returns:

this

Throws:

IllegalStateException

setCompression

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setCompression(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression value)
                                                                     throws IllegalStateException

Sets the value of the compression.

Parameters:

value - Compression representation of the compression

Returns:

this

Throws:

IllegalStateException

copyOf

public static MSBearerCapability.GSM.Content.NonSpeech.DataProtocol copyOf(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol 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:

DataProtocol

clone

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol 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

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 the fields of a sequence. 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 uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

encodedIsInvalid

protected boolean encodedIsInvalid()

Determines whether the encoded form is invalid.

Returns:

boolean

getEncodedForm

public byte[] getEncodedForm()
                      throws EncodeException

Gets the encoded form.

Returns:

encoded form

Throws:

EncodeException - if encoding fails

getContainedLength

public static int getContainedLength(byte[] data,
                                     int start,
                                     int len)

Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. Values of this type are of a fixed length, so that length is returned if the data is long enough, otherwise 0 is returned.

Parameters:

data - network-encoded data

start - index into data where value commences

len - length in data to be considered

Returns:

1, or 0 if encoded value is not long enough

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if choice does not match already encoded coding standard

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if too few or too many octets to be decoded