public static final class BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem extends AbstractLazyEncodedByteArray
The API offered by this class is as if the type were specified in ASN.1 as follows.
ParityAndModem ::= SEQUENCE { numberOfStopBits NumberOfStopBits, numberOfDataBits NumberOfDataBits, parity Parity, modem Modem 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 ITU-T Q.931 (05/98) §4.5.5 p58 | ||||||||
---|---|---|---|---|---|---|---|---|
8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
Octet 5c | ext. 0/1 | Number of stop bits | Number of data bits | Parity | ||||
Octet 5d* | ext. 1 | Duplex mode | Modem type |
Modifier and Type | Class and Description |
---|---|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem
Class Modem represents the DuplexMode and ModemType within a BearerCapability.ITU_T.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits
ITU-T Number of Data Bits (excluding parity bit if present) constants.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits
ITU-T Number of Stop Bits constants.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity
ITU-T Parity constants.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem()
Constructs a new ParityAndModem object with no fields set.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(byte[] data)
Constructs a new ParityAndModem object from network-encoded data.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(byte[] data,
int start,
int len)
Constructs a new ParityAndModem object from part of network-encoded data.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(DataInput in)
Constructs a new ParityAndModem 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.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
clone()
Constructs a copy of this object and everything reachable from it.
|
static BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
copyOf(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem 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.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem |
getModem()
Gets the value of any DuplexMode and ModemType.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits |
getNumberOfDataBits()
Gets the value of number of data bits excluding parity bit if present.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits |
getNumberOfStopBits()
Gets the value of the number of stop bits.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity |
getParity()
Gets the value of the parity information.
|
boolean |
hasModem()
Tests whether the field Modem has a value.
|
boolean |
hasNumberOfDataBits()
Tests whether the field NumberOfDataBits has a value.
|
boolean |
hasNumberOfStopBits()
Tests whether the field NumberOfStopBits has a value.
|
boolean |
hasParity()
Tests whether the field Parity has a value.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
setModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem value)
Sets the value of any DuplexMode and ModemType.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
setNumberOfDataBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits value)
Sets the value of number of data bits excluding parity bit if present.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
setNumberOfStopBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits value)
Sets the value of the number of stop bits.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
setParity(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity value)
Sets the value of the parity information.
|
void |
setReadOnly()
Sets this and all its fields to be immutable.
|
void |
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem()
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(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 BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(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
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(DataInput)
.out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasNumberOfStopBits() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasNumberOfDataBits() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasParity() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasModem() 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 BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits getNumberOfStopBits() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits getNumberOfDataBits() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity getParity() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem getModem() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setNumberOfStopBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits value) throws IllegalStateException
value
- NumberOfStopBits representation of the number of stop bitsIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setNumberOfDataBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits value) throws IllegalStateException
value
- NumberOfDataBits representation of number of data bits excluding parity bit if presentIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setParity(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity value) throws IllegalStateException
value
- Parity representation of the parity informationIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem value) throws IllegalStateException
value
- Modem representation of any DuplexMode and ModemTypeIllegalStateException
public static BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem copyOf(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem from)
from
- the object from which to copypublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public void setReadOnly()
setReadOnly
in interface DataObject
setReadOnly
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 any mandatory field is null or out of rangeprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if too few or too many octets to be decoded, or RateMultiplier required but omitted