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

Class MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

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.Access.O5a

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

MSBearerCapability.GSM.Content.NonSpeech.Access

public static final class MSBearerCapability.GSM.Content.NonSpeech.Access.O5a
extends AbstractLazyEncodedByteArray

Class O5a represents the data of octets 5a*..5b* in 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.

 O5a ::= SEQUENCE {
     otherRateAdaption OtherRateAdaption,
     otherITC          OtherITC,
     o5b               O5b OPTIONAL,
 }

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 5a*	ext. 0/1	Other ITC		Other rate adaption		Spare (000)
Octet 5b*	ext. 1	Hdr/No Hdr	Multiframe	Mode	Logical link identifier	Assignor/ee	Inband negotiation	Spare (0)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b Class O5b represents the data in octet 5b* of a MSBearerCapability.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherITC OtherITC constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherRateAdaption OtherRateAdaption constants.

Field Summary

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a() Constructs a new O5a object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(byte[] data) Constructs a new O5a object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(byte[] data, int start, int len) Constructs a new O5a object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(DataInput in) Constructs a new O5a object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Access.O5a	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a 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.
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.
byte[]	getEncodedForm() Gets the encoded form.
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.Access.O5a.O5b	getO5b() Gets the value of the octet 5b* data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherITC	getOtherITC() Gets the value of the other ITC.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherRateAdaption	getOtherRateAdaption() Gets the value of the other rate adaption.
boolean	hasO5b() Tests whether the field O5b has a value.
boolean	hasOtherITC() Tests whether the field OtherITC has a value.
boolean	hasOtherRateAdaption() Tests whether the field OtherRateAdaption has a value.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a	setO5b(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b value) Sets the value of the octet 5b* data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a	setOtherITC(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherITC value) Sets the value of the other ITC.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a	setOtherRateAdaption(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherRateAdaption value) Sets the value of the other rate adaption.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(DataInput).

Methods inherited from class 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

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a()

Constructs a new O5a object with no fields set.

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(byte[] data)

Constructs a new O5a 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

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(byte[] data,
                                                   int start,
                                                   int len)

Constructs a new O5a 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

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(DataInput in)
                                                    throws IOException

Constructs a new O5a 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 MSBearerCapability.GSM.Content.NonSpeech.Access.O5a(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasOtherRateAdaption

public boolean hasOtherRateAdaption()
                             throws DecodeException

Tests whether the field OtherRateAdaption has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasOtherITC

public boolean hasOtherITC()
                    throws DecodeException

Tests whether the field OtherITC has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasO5b

public boolean hasO5b()
               throws DecodeException

Tests whether the field O5b 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

getOtherRateAdaption

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherRateAdaption getOtherRateAdaption()
                                                                                           throws DecodeException

Gets the value of the other rate adaption.

Returns:

OtherRateAdaption representation of the other rate adaption

Throws:

DecodeException - if encoded state cannot be decoded

getOtherITC

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherITC getOtherITC()
                                                                         throws DecodeException

Gets the value of the other ITC.

Returns:

OtherITC representation of the other ITC

Throws:

DecodeException - if encoded state cannot be decoded

getO5b

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b getO5b()
                                                               throws DecodeException

Gets the value of the octet 5b* data.

Returns:

O5b representation of the octet 5b* data

Throws:

DecodeException - if encoded state cannot be decoded

setOtherRateAdaption

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a setOtherRateAdaption(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherRateAdaption value)
                                                                         throws IllegalStateException

Sets the value of the other rate adaption.

Parameters:

value - OtherRateAdaption representation of the other rate adaption

Returns:

this

Throws:

IllegalStateException

setOtherITC

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a setOtherITC(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.OtherITC value)
                                                                throws IllegalStateException

Sets the value of the other ITC.

Parameters:

value - OtherITC representation of the other ITC

Returns:

this

Throws:

IllegalStateException

setO5b

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a setO5b(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b value)
                                                           throws IllegalStateException

Sets the value of the octet 5b* data.

Parameters:

value - O5b representation of the octet 5b* data

Returns:

this

Throws:

IllegalStateException

copyOf

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

O5a

clone

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a 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. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.

Parameters:

data - network-encoded data

start - index into data where value commences

len - length in data to be considered

Returns:

length of encoded value, or 0 if not decodable

Throws:

NullPointerException - if data is null

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