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

Class 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
    87654321
    Octet 3ext. 1Coding standardInterpretationPresentation method of protocol profile
    Octet 4ext. 0/1High 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

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

      • 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

      • 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

      • 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]