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

Class BearerCapability.ITU_T.Layer3Capability

  • All Implemented Interfaces:
    DataObject, Serializable
    Enclosing class:
    BearerCapability.ITU_T
    public static final class BearerCapability.ITU_T.Layer3Capability
extends AbstractLazyEncodedByteArray
    Class Layer3Capability represents the layer 3 capability 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. 

     Layer3Capability ::= SEQUENCE {
     layer3Protocol   Layer3Protocol,
     layer3ProtocolId Layer3ProtocolId OPTIONAL
 }
    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.5 p58
    87654321
    Octet 7ext. 0Layer 3 ident. (11)User information layer 3 protocol
    Octet 7a*ext. 0Spare (000)Additional layer 3 protocol information (most significant bits)
    Octet 7b*ext. 1Spare (000)Additional layer 3 protocol information (least significant bits)

    The octet numbering in the above table is that used in the cited standard for the octets encoded here.
    See Also:
    Serialized Form

    • Constructor Detail

      • Layer3Capability

        public Layer3Capability()
        Constructs a new Layer3Capability object with no fields set.

      • Layer3Capability

        public Layer3Capability​(byte[] data)
        Constructs a new Layer3Capability 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

      • Layer3Capability

        public Layer3Capability​(byte[] data,
                        int start,
                        int len)
        Constructs a new Layer3Capability 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

      • Layer3Capability

        public Layer3Capability​(DataInput in)
                 throws IOException
        Constructs a new Layer3Capability 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 {@link #BearerCapability.ITU_T.Layer3Capability(DataInput)}.
        Parameters:
        out - the stream to write to
        Throws:
        IOException - if an I/O error occurs

      • hasLayer3Protocol

        public boolean hasLayer3Protocol()
                          throws DecodeException
        Tests whether the field Layer3Protocol has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasLayer3ProtocolId

        public boolean hasLayer3ProtocolId()
                            throws DecodeException
        Tests whether the field Layer3ProtocolId has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • 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 Layer3Protocol is null, or outside range [0,31], or is ISO_IEC_TR_9577 and Layer3ProtocolId is either null or outside range [0,255]