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

Class Cause

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class Cause
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class Cause represents diagnostic information. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.Cause.

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

 Cause ::= SEQUENCE {
   codingStandard CodingStandard,
   location       Location,
   recommendation Recommendation OPTIONAL,
   causeValue     CauseValue,
   diagnostics    OCTET STRING
 }

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.763 (12/1999) §3.12 p26, ITU-T Q.850 (05/98) §2.1 p1, and 3GPP TS 24.008 V4.17.0 (2007-09) §10.5.4.11 pp368-373
	8	7	6	5	4	3	2	1
Octet 3	ext. 0/1	Coding standard		Spare 0	Location
Octet 3a*	ext. 1	Recommendation
Octet 4	ext. 1	Cause value
Octet 5..	Diagnostic(s) if any

The octet numbering in the above table is that used in 3GPP TS 24.008 V4.17.0 (2007-09). Octet 3a is optional, its presence being indicated by ext 0 in octet 3, and its default value being Q.931.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cause.CauseValue Class CauseValue represents cause value constants.
static class	Cause.CodingStandard Enumeration of Coding Standard constants.
static class	Cause.Location Enumeration of Location constants.
static class	Cause.Recommendation Recommendation 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
Cause() Constructs a new Cause object with no fields set.
Cause(byte[] data) Constructs a new Cause object from network-encoded data.
Cause(byte[] data, int start, int len) Constructs a new Cause object from part of network-encoded data.
Cause(Cause.CauseValue causeValue) Constructs a new Cause object from the given argument, with a CodingStandard of ITU_T, a Location of USER, a null Recommendation, and no diagnostics.
Cause(Cause.CodingStandard codingStandard, Cause.Location location, Cause.Recommendation recommendation, Cause.CauseValue causeValue, byte[] diagnostics) Constructs a new Cause object from the given arguments.
Cause(DataInput in) Constructs a new Cause 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.
Cause	clone() Constructs a copy of this object and everything reachable from it.
static Cause	copyOf(Cause 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.
Cause.CauseValue	getCauseValue() Gets the value of the cause value.
Cause.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[]	getDiagnostics() Gets the value of the diagnostics.
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.
Cause.Location	getLocation() Gets the value of the location.
Cause.Recommendation	getRecommendation() Gets the value of the recommendation.
boolean	hasCauseValue() Tests whether the field CauseValue has a value.
boolean	hasCodingStandard() Tests whether the field CodingStandard has a value.
boolean	hasDiagnostics() Tests whether the field Diagnostics has a value.
boolean	hasLocation() Tests whether the field Location has a value.
boolean	hasRecommendation() Tests whether the field Recommendation has a value.
Cause	setCauseValue(Cause.CauseValue value) Sets the value of the cause value.
Cause	setCodingStandard(Cause.CodingStandard value) Sets the value of the coding standard.
Cause	setDiagnostics(byte[] value) Sets the value of the diagnostics.
Cause	setLocation(Cause.Location value) Sets the value of the location.
Cause	setRecommendation(Cause.Recommendation value) Sets the value of the recommendation.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by Cause(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

Cause

public Cause()

Constructs a new Cause object with no fields set.

Cause

public Cause(byte[] data)

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

Cause

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

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

Cause

public Cause(DataInput in)
      throws IOException

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

Cause

public Cause(Cause.CauseValue causeValue)

Constructs a new Cause object from the given argument, with a CodingStandard of ITU_T, a Location of USER, a null Recommendation, and no diagnostics.

Parameters:

causeValue - the cause. The value should be taken from one of the constants defined in this class if the coding standard is Cause.CodingStandard.ITU_T.

Throws:

NullPointerException - if causeValue is null

Cause

public Cause(Cause.CodingStandard codingStandard,
     Cause.Location location,
     Cause.Recommendation recommendation,
     Cause.CauseValue causeValue,
     byte[] diagnostics)

Constructs a new Cause object from the given arguments.

Parameters:

codingStandard - the coding standard by which the cause indicator is encoded

location - the location of the cause

recommendation - the recommendation of the cause

causeValue - the cause

diagnostics - any diagnostics associated with the cause. Refer ITU-T Q.850 for encoding of diagnostic information. Not all causes permit and not all protocols support diagnostic information, in which case null is an acceptable parameter value, and is treated as if a zero-length byte array had been supplied.

Method Detail

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by Cause(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

hasLocation

public boolean hasLocation()
                    throws DecodeException

Tests whether the field Location has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasRecommendation

public boolean hasRecommendation()
                          throws DecodeException

Tests whether the field Recommendation has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasCauseValue

public boolean hasCauseValue()
                      throws DecodeException

Tests whether the field CauseValue has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasDiagnostics

public boolean hasDiagnostics()
                       throws DecodeException

Tests whether the field Diagnostics 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 Cause.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

getLocation

public Cause.Location getLocation()
                           throws DecodeException

Gets the value of the location.

Returns:

Location representation of the location

Throws:

DecodeException - if encoded state cannot be decoded

getRecommendation

public Cause.Recommendation getRecommendation()
                                       throws DecodeException

Gets the value of the recommendation.

Returns:

Recommendation representation of the recommendation

Throws:

DecodeException - if encoded state cannot be decoded

getCauseValue

public Cause.CauseValue getCauseValue()
                               throws DecodeException

Gets the value of the cause value.

Returns:

CauseValue representation of the cause value

Throws:

DecodeException - if encoded state cannot be decoded

getDiagnostics

public byte[] getDiagnostics()
                      throws DecodeException

Gets the value of the diagnostics.

Returns:

byte[] representation of the diagnostics

Throws:

DecodeException - if encoded state cannot be decoded

setCodingStandard

public Cause setCodingStandard(Cause.CodingStandard value)
                        throws IllegalStateException

Sets the value of the coding standard.

Parameters:

value - CodingStandard representation of the coding standard

Returns:

this

Throws:

IllegalStateException

setLocation

public Cause setLocation(Cause.Location value)
                  throws IllegalStateException

Sets the value of the location.

Parameters:

value - Location representation of the location

Returns:

this

Throws:

IllegalStateException

setRecommendation

public Cause setRecommendation(Cause.Recommendation value)
                        throws IllegalStateException

Sets the value of the recommendation.

Parameters:

value - Recommendation representation of the recommendation

Returns:

this

Throws:

IllegalStateException

setCauseValue

public Cause setCauseValue(Cause.CauseValue value)
                    throws IllegalStateException

Sets the value of the cause value.

Parameters:

value - CauseValue representation of the cause value

Returns:

this

Throws:

IllegalStateException

setDiagnostics

public Cause setDiagnostics(byte[] value)
                     throws IllegalStateException

Sets the value of the diagnostics.

Parameters:

value - byte[] representation of the diagnostics

Returns:

this

Throws:

IllegalStateException

copyOf

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

Cause

clone

public Cause 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 variable length, so the given 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:

len, or 0 if encoded value is not long enough

encode

protected void encode()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if less than 2 octets to be decoded