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

Class BearerCapability.ITU_T.Layer1Capability.Details

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.cc.BearerCapability.ITU_T.Layer1Capability.Details

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

BearerCapability.ITU_T.Layer1Capability

public static final class BearerCapability.ITU_T.Layer1Capability.Details
extends AbstractLazyEncodedByteArray

Class Details represents data that is relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120, V110, I460 or X30, or TransferCapability is AUDIO_3_1KHZ and Layer1Protocol is G711. 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.

 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

The octet numbering in the above table is that used in the cited standard for the octets encoded here.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	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.

Field Summary

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
Details()	Constructs a new Details object with no fields set.
Details(byte[] data)	Constructs a new Details object from network-encoded data.
Details(byte[] data, int start, int len)	Constructs a new Details object from part of network-encoded data.
Details(DataInput in)	Constructs a new Details object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Modifier and Type	Method	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 {@link #BearerCapability.ITU_T.Layer1Capability.Details(DataInput)}.

Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Details

public Details()

Constructs a new Details object with no fields set.

Details

public Details(byte[] data)

Constructs a new Details 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

Details

public Details(byte[] data,
               int start,
               int len)

Constructs a new Details 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

Details

public Details(DataInput in)
        throws IOException

Constructs a new Details 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 {@link #BearerCapability.ITU_T.Layer1Capability.Details(DataInput)}.

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasAsynchronous

public boolean hasAsynchronous()
                        throws DecodeException

Tests whether the field Asynchronous has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setAsynchronousPresent

public BearerCapability.ITU_T.Layer1Capability.Details setAsynchronousPresent(boolean flag)
                                                                       throws IllegalStateException

Sets the presence or absence of the field Asynchronous.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

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

hasUserRate

public boolean hasUserRate()
                    throws DecodeException

Tests whether the field UserRate has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasUnrestrictedDigital

public boolean hasUnrestrictedDigital()
                               throws DecodeException

Tests whether the field UnrestrictedDigital has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasParityAndModem

public boolean hasParityAndModem()
                          throws DecodeException

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

getAsynchronous

public boolean getAsynchronous()
                        throws DecodeException

Gets the value of synchronous/asynchronous.

Returns:

boolean representation of synchronous/asynchronous

Throws:

DecodeException - if encoded state cannot be decoded

getInbandNegotiation

public BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation getInbandNegotiation()
                                                                                       throws DecodeException

Gets the value of whether in-band negotiation is possible.

Returns:

InbandNegotiation representation of whether in-band negotiation is possible

Throws:

DecodeException - if encoded state cannot be decoded

getUserRate

public BearerCapability.ITU_T.Layer1Capability.Details.UserRate getUserRate()
                                                                     throws DecodeException

Gets the value of the user rate.

Returns:

UserRate representation of the user rate

Throws:

DecodeException - if encoded state cannot be decoded

getUnrestrictedDigital

public BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital getUnrestrictedDigital()
                                                                                           throws DecodeException

Gets the value of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30.

Returns:

UnrestrictedDigital representation of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30

Throws:

DecodeException - if encoded state cannot be decoded

getParityAndModem

public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem getParityAndModem()
                                                                                 throws DecodeException

Gets the value of any stop and data bits, parity, duplex mode and modem type.

Returns:

ParityAndModem representation of any stop and data bits, parity, duplex mode and modem type

Throws:

DecodeException - if encoded state cannot be decoded

setAsynchronous

public BearerCapability.ITU_T.Layer1Capability.Details setAsynchronous(boolean value)
                                                                throws IllegalStateException

Sets the value of synchronous/asynchronous.

Parameters:

value - boolean representation of synchronous/asynchronous

Returns:

this

Throws:

IllegalStateException

setInbandNegotiation

public BearerCapability.ITU_T.Layer1Capability.Details setInbandNegotiation(BearerCapability.ITU_T.Layer1Capability.Details.InbandNegotiation value)
                                                                     throws IllegalStateException

Sets the value of whether in-band negotiation is possible.

Parameters:

value - InbandNegotiation representation of whether in-band negotiation is possible

Returns:

this

Throws:

IllegalStateException

setUserRate

public BearerCapability.ITU_T.Layer1Capability.Details setUserRate(BearerCapability.ITU_T.Layer1Capability.Details.UserRate value)
                                                            throws IllegalStateException

Sets the value of the user rate.

Parameters:

value - UserRate representation of the user rate

Returns:

this

Throws:

IllegalStateException

setUnrestrictedDigital

public BearerCapability.ITU_T.Layer1Capability.Details setUnrestrictedDigital(BearerCapability.ITU_T.Layer1Capability.Details.UnrestrictedDigital value)
                                                                       throws IllegalStateException

Sets the value of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30.

Parameters:

value - UnrestrictedDigital representation of data relevant when TransferCapability is UNRESTRICTED_DIGITAL and Layer1Protocol is V120 or V110 or I460 or X30

Returns:

this

Throws:

IllegalStateException

setParityAndModem

public BearerCapability.ITU_T.Layer1Capability.Details setParityAndModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem value)
                                                                  throws IllegalStateException

Sets the value of any stop and data bits, parity, duplex mode and modem type.

Parameters:

value - ParityAndModem representation of any stop and data bits, parity, duplex mode and modem type

Returns:

this

Throws:

IllegalStateException

copyOf

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

Parameters:

from - the object from which to copy

Returns:

Details

clone

public BearerCapability.ITU_T.Layer1Capability.Details 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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

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

Parameters:

data - network-encoded data

start - index into data where value commences

len - length in data to be considered

Returns:

length of encoded value, or 0 if not decodable

Throws:

NullPointerException - if data is null

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form. throws EncodeException if encoding fails

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if encoding fails

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if decoding fails