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

Class 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
    87654321
    Octet 3ext. 0/1Coding standardSpare 0Location
    Octet 3a*ext. 1Recommendation
    Octet 4ext. 1Cause 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

    • 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​(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

      • 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

      • 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

      • 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

      • 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