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

Class HighLayerCompatibility

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class HighLayerCompatibility
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class HighLayerCompatibility supports a means for a remote user to perform compatibility checking. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.HighLayerCompatibility.

The API offered by this class is as if the type were specified in ASN.1 as follows.

 HighLayerCompatibility ::= SEQUENCE {
     codingStandard  CodingStandard,
     interpretation  Interpretation,
     presentation    Presentation,
     characteristics Characteristics
 }

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.17 p78
	8	7	6	5	4	3	2	1
Octet 3	ext. 1	Coding standard		Interpretation			Presentation method of protocol profile
Octet 4	ext. 0/1	High layer characteristics identification

The octet numbering in the above table is that used in the cited standard for the octets encoded here. Octets 4a and 4b of the standard are not supported by this class, because Signalware SS7 supports only octets 3 and 4. Consequently, bit 8 of octet 4 is always 1, as the situations in which it would be 0 never arise.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HighLayerCompatibility.Characteristics Characteristics constants.
static class	HighLayerCompatibility.CodingStandard Coding standard constants.
static class	HighLayerCompatibility.Interpretation Interpretation constants.
static class	HighLayerCompatibility.Presentation Presentation 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
HighLayerCompatibility() Constructs a new HighLayerCompatibility object with no fields set.
HighLayerCompatibility(byte[] data) Constructs a new HighLayerCompatibility object from network-encoded data.
HighLayerCompatibility(byte[] data, int start, int len) Constructs a new HighLayerCompatibility object from part of network-encoded data.
HighLayerCompatibility(DataInput in) Constructs a new HighLayerCompatibility object from data deserialized from a stream that was written by toStream(DataOutput).
HighLayerCompatibility(HighLayerCompatibility.CodingStandard codingStandard, HighLayerCompatibility.Interpretation interpretation, HighLayerCompatibility.Presentation presentation, HighLayerCompatibility.Characteristics characteristics) Constructs a new HighLayerCompatibility object from given values for all fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
HighLayerCompatibility	clone() Constructs a copy of this object and everything reachable from it.
static HighLayerCompatibility	copyOf(HighLayerCompatibility 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.
HighLayerCompatibility.Characteristics	getCharacteristics() Gets the value of the high layer characteristics identification.
HighLayerCompatibility.CodingStandard	getCodingStandard() Gets the value of the coding standard.
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.
HighLayerCompatibility.Interpretation	getInterpretation() Gets the value of the interpretation.
HighLayerCompatibility.Presentation	getPresentation() Gets the value of the presentation method of protocol profile.
boolean	hasCharacteristics() Tests whether the field Characteristics has a value.
boolean	hasCodingStandard() Tests whether the field CodingStandard has a value.
boolean	hasInterpretation() Tests whether the field Interpretation has a value.
boolean	hasPresentation() Tests whether the field Presentation has a value.
HighLayerCompatibility	setCharacteristics(HighLayerCompatibility.Characteristics value) Sets the value of the high layer characteristics identification.
HighLayerCompatibility	setCodingStandard(HighLayerCompatibility.CodingStandard value) Sets the value of the coding standard.
HighLayerCompatibility	setInterpretation(HighLayerCompatibility.Interpretation value) Sets the value of the interpretation.
HighLayerCompatibility	setPresentation(HighLayerCompatibility.Presentation value) Sets the value of the presentation method of protocol profile.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by HighLayerCompatibility(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

HighLayerCompatibility

public HighLayerCompatibility()

Constructs a new HighLayerCompatibility object with no fields set.

HighLayerCompatibility

public HighLayerCompatibility(byte[] data)

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

HighLayerCompatibility

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

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

HighLayerCompatibility

public HighLayerCompatibility(HighLayerCompatibility.CodingStandard codingStandard,
                      HighLayerCompatibility.Interpretation interpretation,
                      HighLayerCompatibility.Presentation presentation,
                      HighLayerCompatibility.Characteristics characteristics)

Constructs a new HighLayerCompatibility object from given values for all fields.

Parameters:

codingStandard - the coding standard

interpretation - the interpretation

presentation - the presentation method of protocol profile

characteristics - the high layer characteristics identification

HighLayerCompatibility

public HighLayerCompatibility(DataInput in)
                       throws IOException

Constructs a new HighLayerCompatibility 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 HighLayerCompatibility(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasCodingStandard

public boolean hasCodingStandard()
                          throws DecodeException

Tests whether the field CodingStandard has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasInterpretation

public boolean hasInterpretation()
                          throws DecodeException

Tests whether the field Interpretation has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasPresentation

public boolean hasPresentation()
                        throws DecodeException

Tests whether the field Presentation has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasCharacteristics

public boolean hasCharacteristics()
                           throws DecodeException

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

getCodingStandard

public HighLayerCompatibility.CodingStandard getCodingStandard()
                                                        throws DecodeException

Gets the value of the coding standard.

Returns:

CodingStandard representation of the coding standard

Throws:

DecodeException - if encoded state cannot be decoded

getInterpretation

public HighLayerCompatibility.Interpretation getInterpretation()
                                                        throws DecodeException

Gets the value of the interpretation.

Returns:

Interpretation representation of the interpretation

Throws:

DecodeException - if encoded state cannot be decoded

getPresentation

public HighLayerCompatibility.Presentation getPresentation()
                                                    throws DecodeException

Gets the value of the presentation method of protocol profile.

Returns:

Presentation representation of the presentation method of protocol profile

Throws:

DecodeException - if encoded state cannot be decoded

getCharacteristics

public HighLayerCompatibility.Characteristics getCharacteristics()
                                                          throws DecodeException

Gets the value of the high layer characteristics identification.

Returns:

Characteristics representation of the high layer characteristics identification

Throws:

DecodeException - if encoded state cannot be decoded

setCodingStandard

public HighLayerCompatibility setCodingStandard(HighLayerCompatibility.CodingStandard value)
                                         throws IllegalStateException

Sets the value of the coding standard.

Parameters:

value - CodingStandard representation of the coding standard

Returns:

this

Throws:

IllegalStateException

setInterpretation

public HighLayerCompatibility setInterpretation(HighLayerCompatibility.Interpretation value)
                                         throws IllegalStateException

Sets the value of the interpretation.

Parameters:

value - Interpretation representation of the interpretation

Returns:

this

Throws:

IllegalStateException

setPresentation

public HighLayerCompatibility setPresentation(HighLayerCompatibility.Presentation value)
                                       throws IllegalStateException

Sets the value of the presentation method of protocol profile.

Parameters:

value - Presentation representation of the presentation method of protocol profile

Returns:

this

Throws:

IllegalStateException

setCharacteristics

public HighLayerCompatibility setCharacteristics(HighLayerCompatibility.Characteristics value)
                                          throws IllegalStateException

Sets the value of the high layer characteristics identification.

Parameters:

value - Characteristics representation of the high layer characteristics identification

Returns:

this

Throws:

IllegalStateException

copyOf

public static HighLayerCompatibility copyOf(HighLayerCompatibility 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:

HighLayerCompatibility

clone

public HighLayerCompatibility 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. Values of this type are of a fixed length, so that length is returned if the data is long enough, otherwise 0 is returned.

Parameters:

data - network-encoded data

start - index into data where value commences

len - length in data to be considered

Returns:

2, or 0 if encoded value is not long enough

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if CodingStandard is not in range [0,3] or Interpretation is not in range [0,7] or Presentation is not in range [0,3] or Characteristics is not in range [0,127]

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if not 2 octets to be decoded