Package com.opencloud.slee.resources.cgin

Class EncodedStringWithIndicators

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class EncodedStringWithIndicators
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class EncodedStringWithIndicators represents the encoded form of a string field.

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

     EncodedStringWithIndicators ::= SEQUENCE {
     data       OCTET STRING,
     indicators StringIndicators
 }
    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 - made up by OpenCloud
    87654321
    Octet 0Indicators
    Octet 1
    Octets 2..Data
    See Also:
    Serialized Form

    • Constructor Detail

      • EncodedStringWithIndicators

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

      • EncodedStringWithIndicators

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

      • EncodedStringWithIndicators

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

      • EncodedStringWithIndicators

        public EncodedStringWithIndicators​(byte[] data,
                                   StringIndicators indicators)
        Constructs a new EncodedStringWithIndicators object from given values for all fields.
        Parameters:
        data - the encoded octet string
        indicators - the indicators

      • EncodedStringWithIndicators

        public EncodedStringWithIndicators​(DataInput in)
                            throws IOException
        Constructs a new EncodedStringWithIndicators 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

      • hasData

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

      • hasIndicators

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

      • getData

        public byte[] getData()
               throws DecodeException
        Gets the value of the encoded octet string.
        Returns:
        byte[] representation of the encoded octet string
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getIndicators

        public StringIndicators getIndicators()
                               throws DecodeException
        Gets the value of the indicators.
        Returns:
        StringIndicators representation of the indicators
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

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

      • 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