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

Class AccessPointNameOperatorId

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public class AccessPointNameOperatorId
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class AccessPointNameOperatorId represents an APN-OI-Replacement field.

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

     AccessPointNameOperatorId ::= SEQUENCE {
     operatorId  CharString
 }

    The operatorId is of the form ...label.label.gprs, with at least two labels before .gprs. All labels are alphanumeric, with hyphens permitted in-between alphanumerics.

    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 3GPP TS 23.003 V10.0.0 (2010-12) §9 pp30-32
    87654321
    Octet 0Length (n) of 1st label
    Octet 1Characters of 1st label
    ..
    Octet n
    ...Further labels

    Each label is encoded as its length followed by its characters, excluding any dot. The length of the data encoding depends on the length of the character string.
    See Also:
    Serialized Form

    • Constructor Detail

      • AccessPointNameOperatorId

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

      • AccessPointNameOperatorId

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

      • AccessPointNameOperatorId

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

      • AccessPointNameOperatorId

        public AccessPointNameOperatorId​(String operatorId)
        Constructs a new AccessPointNameOperatorId object from given values for all fields.
        Parameters:
        operatorId - the operator identifier

      • AccessPointNameOperatorId

        public AccessPointNameOperatorId​(String operatorId,
                                 StringCodec<AccessPointNameOperatorId> OperatorId_codec)
        Constructs a new AccessPointNameOperatorId object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        operatorId - the operator identifier
        OperatorId_codec - StringCodec for operatorId

      • AccessPointNameOperatorId

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

      • hasOperatorId

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

      • getOperatorId

        public String getOperatorId​(StringCodec<AccessPointNameOperatorId> codec)
                     throws DecodeException
        Gets the value of the operator identifier using the given codec. If the field OperatorId is not set, returns null. If the given codec is null, then uses the standard codec for this field.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of the operator identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getOperatorIdEncoded

        public byte[] getOperatorIdEncoded()
        Gets a clone of the encoded value of the operator identifier.
        Returns:
        byte[] representation of the operator identifier

      • setOperatorIdEncoded

        public AccessPointNameOperatorId setOperatorIdEncoded​(byte[] encoded)
        Sets the encoded value of the operator identifier to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of the operator identifier
        Returns:
        this

      • copyOf

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

      • 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