public static final class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability extends AbstractLazyEncodedByteArray
The API offered by this class is as if the type were specified in ASN.1 as follows.
Layer1Capability ::= SEQUENCE { asynchronous BOOLEAN, layer1Protocol Layer1Protocol, o6a O6a 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 6* | ext. 0/1 | Layer 1 id. (01) | User information layer 1 protocol | Async? | ||||
Octet 6a* | ext. 0/1 | Number of stop bits | Negotiation | Number of data bits | User rate | |||
Octet 6b* | ext. 0/1 | Intermediate rate | NIC on Tx | NIC on Rx | Parity | |||
Octet 6c* | ext. 0/1 | Connection element | Modem type | |||||
Octet 6d* | ext. 0/1 | Other modem type | Fixed network user rate | |||||
Octet 6e* | ext. 0/1 | Acceptable channel codings | Maximum number of traffic channels | |||||
Octet 6f* | ext. 0/1 | UIMI | Wanted air interface user rate | |||||
Octet 6g* | ext. 1 | Acceptable channel codings extended | Asymmetry indication | Spare (00) |
There is a static condition in standard 24.008 that says if octet 6 is present then octet 6a shall also be present, in the GSM encoding. Contradicting that, the standard allows the ext bit in octet 6 to be 1, which would indicate that there is no following octet 6a. As a compromise, this API offers field O6a as an OPTIONAL field, but with this recommendation: you should always provide a value for field O6a.
Modifier and Type | Class and Description |
---|---|
static class |
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol
User Information Layer 1 Protocol constants.
|
static class |
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
Class O6a represents octets 6a to 6g within a MSBearerCapability.Layer1Capability
It represents part of a larger octet string; it is not transmitted on a network by itself.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability()
Constructs a new Layer1Capability object with no fields set.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data)
Constructs a new Layer1Capability object from network-encoded data.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data,
int start,
int len)
Constructs a new Layer1Capability object from part of network-encoded data.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(DataInput in)
Constructs a new Layer1Capability object from data deserialized from a stream that was written by
toStream(DataOutput) . |
Modifier and Type | Method and Description |
---|---|
void |
checkFieldsSet()
Checks that all mandatory fields are present.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
clone()
Constructs a copy of this object and everything reachable from it.
|
static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability 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.
|
boolean |
getAsynchronous()
Gets the value of synchronous/asynchronous.
|
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.Layer1Capability.Layer1Protocol |
getLayer1Protocol()
Gets the value of the user information layer 1 protocol.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a |
getO6a()
Gets the value of the octets 6a*..6g*.
|
boolean |
hasAsynchronous()
Tests whether the field Asynchronous has a value.
|
boolean |
hasLayer1Protocol()
Tests whether the field Layer1Protocol has a value.
|
boolean |
hasO6a()
Tests whether the field O6a has a value.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
setAsynchronous(boolean value)
Sets the value of synchronous/asynchronous.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
setAsynchronousPresent(boolean flag)
Sets the presence or absence of the field Asynchronous.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
setLayer1Protocol(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol value)
Sets the value of the user information layer 1 protocol.
|
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability |
setO6a(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a value)
Sets the value of the octets 6a*..6g*.
|
void |
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability()
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data, int start, int len)
start
and is len
bytes long.
The data is not decoded and might not be decodable.data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictableNullPointerException
- if data is nullIllegalArgumentException
- if len is negativepublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(DataInput in) throws IOException
toStream(DataOutput)
.in
- the stream to read fromEOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be readpublic void toStream(DataOutput out) throws IOException
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(DataInput)
.out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasAsynchronous() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability setAsynchronousPresent(boolean flag) throws IllegalStateException
flag
- whether the field should be marked as presentIllegalStateException
- if this instance has been marked as read-onlypublic boolean hasLayer1Protocol() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasO6a() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic void checkFieldsSet() throws EncodeException
checkFieldsSet
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if any mandatory field is not presentpublic boolean getAsynchronous() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol getLayer1Protocol() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a getO6a() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability setAsynchronous(boolean value) throws IllegalStateException
value
- boolean representation of synchronous/asynchronousIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability setLayer1Protocol(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol value) throws IllegalStateException
value
- Layer1Protocol representation of the user information layer 1 protocolIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability setO6a(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a value) throws IllegalStateException
value
- O6a representation of the octets 6a*..6g*IllegalStateException
public static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability from)
from
- the object from which to copypublic MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public static FieldAccessor[] getFieldAccessors()
public Map<String,Object> getFieldsMap(boolean withAbsents)
getFieldsMap
in class AbstractFieldsObject
withAbsents
- whether to put absent optional fields into Mapprotected boolean encodedIsInvalid()
public byte[] getEncodedForm() throws EncodeException
EncodeException
- if encoding failspublic static int getContainedLength(byte[] data, int start, int len)
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.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredNullPointerException
- if data is nullprotected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if choice does not match already encoded coding standardprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if too few or too many octets to be decoded