public static final class MSBearerCapability.GSM.Content.NonSpeech.DataProtocol extends AbstractLazyEncodedByteArray
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 |
Modifier and Type | Class and 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.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Modifier and Type | Method and 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
MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol()
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(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.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)
establishment
- the establishmentnIRR
- the NIRRconfiguration
- the configurationduplexMode
- the duplex modestructure
- the structurecompression
- the compressionpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol(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.DataProtocol(DataInput)
.out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasEstablishment() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasNIRR() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasConfiguration() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasDuplexMode() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasStructure() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasCompression() 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 MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment getEstablishment() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR getNIRR() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration getConfiguration() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode getDuplexMode() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure getStructure() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression getCompression() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setEstablishment(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Establishment value) throws IllegalStateException
value
- Establishment representation of the establishmentIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setNIRR(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.NIRR value) throws IllegalStateException
value
- NIRR representation of the NIRRIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setConfiguration(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Configuration value) throws IllegalStateException
value
- Configuration representation of the configurationIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setDuplexMode(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.DuplexMode value) throws IllegalStateException
value
- DuplexMode representation of the duplex modeIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setStructure(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Structure value) throws IllegalStateException
value
- Structure representation of the structureIllegalStateException
public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol setCompression(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol.Compression value) throws IllegalStateException
value
- Compression representation of the compressionIllegalStateException
public static MSBearerCapability.GSM.Content.NonSpeech.DataProtocol copyOf(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol from)
from
- the object from which to copypublic MSBearerCapability.GSM.Content.NonSpeech.DataProtocol 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.
Values of this type are of a fixed length, so that length
is returned if the data is long enough, otherwise 0 is returned.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredprotected 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