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

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

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.O5b

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a

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

Class O5b represents the data in octet 5b* of 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.

 O5b ::= SEQUENCE {
     inbandNegotiation InbandNegotiation,
     assigning         Assigning,
     lli               LLI,
     mode              Mode,
     multiframe        Multiframe,
     rateAdaptHeader   RateAdaptHeader
 }

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 5b*	Spare	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.Assigning Enumeration of Assigning constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.InbandNegotiation Enumeration of InbandNegotiation constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.LLI Enumeration of Logical link identifier constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Mode Enumeration of Mode constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Multiframe Enumeration of Multiframe constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.RateAdaptHeader Enumeration of RateAdaptHeader 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.O5b() Constructs a new O5b object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(byte[] data) Constructs a new O5b object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(byte[] data, int start, int len) Constructs a new O5b object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(DataInput in) Constructs a new O5b object from data deserialized from a stream that was written by toStream(DataOutput).
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.InbandNegotiation inbandNegotiation, MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Assigning assigning, MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.LLI lLI, MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Mode mode, MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Multiframe multiframe, MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.RateAdaptHeader rateAdaptHeader) Constructs a new O5b object from given values for all fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b 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.Access.O5a.O5b.Assigning	getAssigning() Gets the value of the assignor/assignee.
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.InbandNegotiation	getInbandNegotiation() Gets the value of the in band/out of band negotiation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.LLI	getLLI() Gets the value of the logical link identifier negotiation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Mode	getMode() Gets the value of the mode of operation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Multiframe	getMultiframe() Gets the value of the multiple frame establishment support in data link.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.RateAdaptHeader	getRateAdaptHeader() Gets the value of the rate adaption header/no header.
boolean	hasAssigning() Tests whether the field Assigning has a value.
boolean	hasInbandNegotiation() Tests whether the field InbandNegotiation has a value.
boolean	hasLLI() Tests whether the field LLI has a value.
boolean	hasMode() Tests whether the field Mode has a value.
boolean	hasMultiframe() Tests whether the field Multiframe has a value.
boolean	hasRateAdaptHeader() Tests whether the field RateAdaptHeader has a value.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setAssigning(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Assigning value) Sets the value of the assignor/assignee.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setInbandNegotiation(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.InbandNegotiation value) Sets the value of the in band/out of band negotiation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setLLI(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.LLI value) Sets the value of the logical link identifier negotiation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setMode(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Mode value) Sets the value of the mode of operation.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setMultiframe(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Multiframe value) Sets the value of the multiple frame establishment support in data link.
MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b	setRateAdaptHeader(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.RateAdaptHeader value) Sets the value of the rate adaption header/no header.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(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.O5b

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

Constructs a new O5b object with no fields set.

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b

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

Constructs a new O5b 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.O5b

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

Constructs a new O5b 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.O5b

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.InbandNegotiation inbandNegotiation,
                                                       MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Assigning assigning,
                                                       MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.LLI lLI,
                                                       MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Mode mode,
                                                       MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.Multiframe multiframe,
                                                       MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b.RateAdaptHeader rateAdaptHeader)

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

Parameters:

inbandNegotiation - the in band/out of band negotiation

assigning - the assignor/assignee

lLI - the logical link identifier negotiation

mode - the mode of operation

multiframe - the multiple frame establishment support in data link

rateAdaptHeader - the rate adaption header/no header

MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b

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

Constructs a new O5b 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.O5b(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasInbandNegotiation

public boolean hasInbandNegotiation()
                             throws DecodeException

Tests whether the field InbandNegotiation has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasAssigning

public boolean hasAssigning()
                     throws DecodeException

Tests whether the field Assigning has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasLLI

public boolean hasLLI()
               throws DecodeException

Tests whether the field LLI has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasMode

public boolean hasMode()
                throws DecodeException

Tests whether the field Mode has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasMultiframe

public boolean hasMultiframe()
                      throws DecodeException

Tests whether the field Multiframe has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasRateAdaptHeader

public boolean hasRateAdaptHeader()
                           throws DecodeException

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

getInbandNegotiation

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

Gets the value of the in band/out of band negotiation.

Returns:

InbandNegotiation representation of the in band/out of band negotiation

Throws:

DecodeException - if encoded state cannot be decoded

getAssigning

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

Gets the value of the assignor/assignee.

Returns:

Assigning representation of the assignor/assignee

Throws:

DecodeException - if encoded state cannot be decoded

getLLI

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

Gets the value of the logical link identifier negotiation.

Returns:

LLI representation of the logical link identifier negotiation

Throws:

DecodeException - if encoded state cannot be decoded

getMode

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

Gets the value of the mode of operation.

Returns:

Mode representation of the mode of operation

Throws:

DecodeException - if encoded state cannot be decoded

getMultiframe

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

Gets the value of the multiple frame establishment support in data link.

Returns:

Multiframe representation of the multiple frame establishment support in data link

Throws:

DecodeException - if encoded state cannot be decoded

getRateAdaptHeader

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

Gets the value of the rate adaption header/no header.

Returns:

RateAdaptHeader representation of the rate adaption header/no header

Throws:

DecodeException - if encoded state cannot be decoded

setInbandNegotiation

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

Sets the value of the in band/out of band negotiation.

Parameters:

value - InbandNegotiation representation of the in band/out of band negotiation

Returns:

this

Throws:

IllegalStateException

setAssigning

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

Sets the value of the assignor/assignee.

Parameters:

value - Assigning representation of the assignor/assignee

Returns:

this

Throws:

IllegalStateException

setLLI

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

Sets the value of the logical link identifier negotiation.

Parameters:

value - LLI representation of the logical link identifier negotiation

Returns:

this

Throws:

IllegalStateException

setMode

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

Sets the value of the mode of operation.

Parameters:

value - Mode representation of the mode of operation

Returns:

this

Throws:

IllegalStateException

setMultiframe

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

Sets the value of the multiple frame establishment support in data link.

Parameters:

value - Multiframe representation of the multiple frame establishment support in data link

Returns:

this

Throws:

IllegalStateException

setRateAdaptHeader

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

Sets the value of the rate adaption header/no header.

Parameters:

value - RateAdaptHeader representation of the rate adaption header/no header

Returns:

this

Throws:

IllegalStateException

copyOf

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

O5b

clone

public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a.O5b 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()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

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