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

Class BearerCapability.ITU_T.Ericsson

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

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

BearerCapability.ITU_T

public static final class BearerCapability.ITU_T.Ericsson
extends AbstractLazyEncodedByteArray

Class Ericsson represents the Ericsson-specific data within a BearerCapability.ITU_T. 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.

 Ericsson ::= SEQUENCE {
     structure     Structure,
     configuration Configuration,
     establishment Establishment,
     ericsson4b    Ericsson4b OPTIONAL
 }

Data Encoding - based on comment in Ericsson-INAP-CS1-Datatypes.asn
	8	7	6	5	4	3	2	1
Octet 4a	ext. 0/1	Structure			Configuration		Establishment
Octet 4b*	ext. 1	Symmetry		Reverse information transfer rate

The octet numbering in the above table results from renumbering Ericsson's 2a and 2b to fit into the numbering used in ITU-T Q.931 (05/98) §4.5.5 p58.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BearerCapability.ITU_T.Ericsson.Configuration Ericsson Configuration constants.
static class	BearerCapability.ITU_T.Ericsson.Ericsson4b Class Ericsson4b represents the data within octet 4b of the Ericsson-specific data.
static class	BearerCapability.ITU_T.Ericsson.Establishment Ericsson Establishment constants.
static class	BearerCapability.ITU_T.Ericsson.Structure Ericsson Structure constants.

Field Summary

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
BearerCapability.ITU_T.Ericsson	clone() Constructs a copy of this object and everything reachable from it.
static BearerCapability.ITU_T.Ericsson	copyOf(BearerCapability.ITU_T.Ericsson 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.
BearerCapability.ITU_T.Ericsson.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.
byte[]	getEncodedForm() Gets the encoded form.
BearerCapability.ITU_T.Ericsson.Ericsson4b	getEricsson4b() Gets the value of the Ericsson-specific octet 4b data.
BearerCapability.ITU_T.Ericsson.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.
BearerCapability.ITU_T.Ericsson.Structure	getStructure() Gets the value of the structure.
boolean	hasConfiguration() Tests whether the field Configuration has a value.
boolean	hasEricsson4b() Tests whether the field Ericsson4b has a value.
boolean	hasEstablishment() Tests whether the field Establishment has a value.
boolean	hasStructure() Tests whether the field Structure has a value.
BearerCapability.ITU_T.Ericsson	setConfiguration(BearerCapability.ITU_T.Ericsson.Configuration value) Sets the value of the configuration.
BearerCapability.ITU_T.Ericsson	setEricsson4b(BearerCapability.ITU_T.Ericsson.Ericsson4b value) Sets the value of the Ericsson-specific octet 4b data.
BearerCapability.ITU_T.Ericsson	setEstablishment(BearerCapability.ITU_T.Ericsson.Establishment value) Sets the value of the establishment.
BearerCapability.ITU_T.Ericsson	setStructure(BearerCapability.ITU_T.Ericsson.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 BearerCapability.ITU_T.Ericsson(DataInput).

Methods inherited from class AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

BearerCapability.ITU_T.Ericsson

public BearerCapability.ITU_T.Ericsson()

Constructs a new Ericsson object with no fields set.

BearerCapability.ITU_T.Ericsson

public BearerCapability.ITU_T.Ericsson(byte[] data)

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

BearerCapability.ITU_T.Ericsson

public BearerCapability.ITU_T.Ericsson(byte[] data,
                               int start,
                               int len)

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

BearerCapability.ITU_T.Ericsson

public BearerCapability.ITU_T.Ericsson(DataInput in)
                                throws IOException

Constructs a new Ericsson 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 BearerCapability.ITU_T.Ericsson(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasStructure

public boolean hasStructure()
                     throws DecodeException

Tests whether the field Structure has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasConfiguration

public boolean hasConfiguration()
                         throws DecodeException

Tests whether the field Configuration has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasEstablishment

public boolean hasEstablishment()
                         throws DecodeException

Tests whether the field Establishment has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasEricsson4b

public boolean hasEricsson4b()
                      throws DecodeException

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

getStructure

public BearerCapability.ITU_T.Ericsson.Structure getStructure()
                                                       throws DecodeException

Gets the value of the structure.

Returns:

Structure representation of the structure

Throws:

DecodeException - if encoded state cannot be decoded

getConfiguration

public BearerCapability.ITU_T.Ericsson.Configuration getConfiguration()
                                                               throws DecodeException

Gets the value of the configuration.

Returns:

Configuration representation of the configuration

Throws:

DecodeException - if encoded state cannot be decoded

getEstablishment

public BearerCapability.ITU_T.Ericsson.Establishment getEstablishment()
                                                               throws DecodeException

Gets the value of the establishment.

Returns:

Establishment representation of the establishment

Throws:

DecodeException - if encoded state cannot be decoded

getEricsson4b

public BearerCapability.ITU_T.Ericsson.Ericsson4b getEricsson4b()
                                                         throws DecodeException

Gets the value of the Ericsson-specific octet 4b data.

Returns:

Ericsson4b representation of the Ericsson-specific octet 4b data

Throws:

DecodeException - if encoded state cannot be decoded

setStructure

public BearerCapability.ITU_T.Ericsson setStructure(BearerCapability.ITU_T.Ericsson.Structure value)
                                             throws IllegalStateException

Sets the value of the structure.

Parameters:

value - Structure representation of the structure

Returns:

this

Throws:

IllegalStateException

setConfiguration

public BearerCapability.ITU_T.Ericsson setConfiguration(BearerCapability.ITU_T.Ericsson.Configuration value)
                                                 throws IllegalStateException

Sets the value of the configuration.

Parameters:

value - Configuration representation of the configuration

Returns:

this

Throws:

IllegalStateException

setEstablishment

public BearerCapability.ITU_T.Ericsson setEstablishment(BearerCapability.ITU_T.Ericsson.Establishment value)
                                                 throws IllegalStateException

Sets the value of the establishment.

Parameters:

value - Establishment representation of the establishment

Returns:

this

Throws:

IllegalStateException

setEricsson4b

public BearerCapability.ITU_T.Ericsson setEricsson4b(BearerCapability.ITU_T.Ericsson.Ericsson4b value)
                                              throws IllegalStateException

Sets the value of the Ericsson-specific octet 4b data.

Parameters:

value - Ericsson4b representation of the Ericsson-specific octet 4b data

Returns:

this

Throws:

IllegalStateException

copyOf

public static BearerCapability.ITU_T.Ericsson copyOf(BearerCapability.ITU_T.Ericsson 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:

Ericsson

clone

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

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.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if any mandatory field is out of range

decode

protected void decode()

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>