public static final class BearerCapability.ITU_T.Layer1Capability.Details extends AbstractLazyEncodedByteArray
The API offered by this class is as if the type were specified in ASN.1 as follows.
Details ::= SEQUENCE { asynchronous BOOLEAN, inbandNegotiation InbandNegotiation, userRate UserRate, unrestrictedDigital UnrestrictedDigital OPTIONAL, parityAndModem ParityAndModem OPTIONAL }The class takes care of encoding the field values into a NamedInteger and decoding field values from a NamedInteger, 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 | |
Has V110? | Has V120? | Has parity and modem? | ||||||
Octet 5a | ext. 0/1 | Asynch? | In-band negotiation | User rate | ||||
Octet 5b* | ext. 0/1 | Intermediate rate | NIC on Tx | NIC on Rx | Flow control on Tx | Flow control on Rx | Spare (0) | |
Octet 5b* | ext. 0/1 | Rate adaptation header | Multiframe | Mode | LLI negotiation | Message originator | Negotiation | Spare (0) |
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.InbandNegotiation
Enumeration of ITU-T Inband Negotiation constants.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem
Class ParityAndModem represents stop and data bit counts, parity, duplex mode and modem type within a BearerCapability.ITU_T.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital
Class UnrestrictedDigital represents data that is relevant when TransferCapability is UNRESTRICTED_DIGITAL
and Layer1Protocol is V120 or V110 or I460 or X30.
|
static class |
BearerCapability.ITU_T.Layer1Capability.Details.UserRate
ITU-T User Rate constants.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
BearerCapability.ITU_T.Layer1Capability.Details()
Constructs a new Details object with no fields set.
|
BearerCapability.ITU_T.Layer1Capability.Details(byte[] data)
Constructs a new Details object from network-encoded data.
|
BearerCapability.ITU_T.Layer1Capability.Details(byte[] data,
int start,
int len)
Constructs a new Details object from part of network-encoded data.
|
BearerCapability.ITU_T.Layer1Capability.Details(DataInput in)
Constructs a new Details 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 |
clone()
Constructs a copy of this object and everything reachable from it.
|
static BearerCapability.ITU_T.Layer1Capability.Details |
copyOf(BearerCapability.ITU_T.Layer1Capability.Details 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.
|
BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation |
getInbandNegotiation()
Gets the value of whether in-band negotiation is possible.
|
BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem |
getParityAndModem()
Gets the value of any stop and data bits, parity, duplex mode and modem type.
|
BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital |
getUnrestrictedDigital()
Gets the value of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30.
|
BearerCapability.ITU_T.Layer1Capability.Details.UserRate |
getUserRate()
Gets the value of the user rate.
|
boolean |
hasAsynchronous()
Tests whether the field Asynchronous has a value.
|
boolean |
hasInbandNegotiation()
Tests whether the field InbandNegotiation has a value.
|
boolean |
hasParityAndModem()
Tests whether the field ParityAndModem has a value.
|
boolean |
hasUnrestrictedDigital()
Tests whether the field UnrestrictedDigital has a value.
|
boolean |
hasUserRate()
Tests whether the field UserRate has a value.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setAsynchronous(boolean value)
Sets the value of synchronous/asynchronous.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setAsynchronousPresent(boolean flag)
Sets the presence or absence of the field Asynchronous.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setInbandNegotiation(BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation value)
Sets the value of whether in-band negotiation is possible.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setParityAndModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem value)
Sets the value of any stop and data bits, parity, duplex mode and modem type.
|
void |
setReadOnly()
Sets this and all its fields to be immutable.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setUnrestrictedDigital(BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital value)
Sets the value of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30.
|
BearerCapability.ITU_T.Layer1Capability.Details |
setUserRate(BearerCapability.ITU_T.Layer1Capability.Details.UserRate value)
Sets the value of the user rate.
|
void |
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by
BearerCapability.ITU_T.Layer1Capability.Details(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly
public BearerCapability.ITU_T.Layer1Capability.Details()
public BearerCapability.ITU_T.Layer1Capability.Details(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic BearerCapability.ITU_T.Layer1Capability.Details(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(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(DataInput)
.out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasAsynchronous() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details setAsynchronousPresent(boolean flag) throws IllegalStateException
flag
- whether the field should be marked as presentIllegalStateException
- if this instance has been marked as read-onlypublic boolean hasInbandNegotiation() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasUserRate() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasUnrestrictedDigital() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasParityAndModem() 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 BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation getInbandNegotiation() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.UserRate getUserRate() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital getUnrestrictedDigital() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem getParityAndModem() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic BearerCapability.ITU_T.Layer1Capability.Details setAsynchronous(boolean value) throws IllegalStateException
value
- boolean representation of synchronous/asynchronousIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details setInbandNegotiation(BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation value) throws IllegalStateException
value
- InbandNegotiation representation of whether in-band negotiation is possibleIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details setUserRate(BearerCapability.ITU_T.Layer1Capability.Details.UserRate value) throws IllegalStateException
value
- UserRate representation of the user rateIllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details setUnrestrictedDigital(BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital value) throws IllegalStateException
value
- UnrestrictedDigital representation of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30IllegalStateException
public BearerCapability.ITU_T.Layer1Capability.Details setParityAndModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem value) throws IllegalStateException
value
- ParityAndModem representation of any stop and data bits, parity, duplex mode and modem typeIllegalStateException
public static BearerCapability.ITU_T.Layer1Capability.Details copyOf(BearerCapability.ITU_T.Layer1Capability.Details from)
from
- the object from which to copypublic BearerCapability.ITU_T.Layer1Capability.Details 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 encoding failsprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if decoding fails