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

Class LMSIAddress

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class LMSIAddress
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class LMSIAddress encapsulates the LMSI (Local Mobile Station Identity), a local identity allocated by the VLR to a given subscriber for internal management of data in the VLR.

    It represents the ASN.1 OCTET STRING type MAP-CommonDataTypes.LMSI.

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

     LMSI ::= SEQUENCE {
     id INTEGER (-2147483648 .. 2147483647)
 }

    Data Encoding - based on 3GPP TS 23.003 V10.0.0 (2010-12) §2.5 p15
    87654321
    Octet 0Id
    Octet 1
    Octet 2
    Octet 3
    See Also:
    Serialized Form

    • Constructor Detail

      • LMSIAddress

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

      • LMSIAddress

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

      • LMSIAddress

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

      • LMSIAddress

        public LMSIAddress​(int id)
        Constructs a new LMSIAddress object from given values for all fields.
        Parameters:
        id - local mobile station identifier

      • LMSIAddress

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

      • hasId

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

      • setIdPresent

        public LMSIAddress setIdPresent​(boolean flag)
                         throws IllegalStateException
        Sets the presence or absence of the field Id.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • getId

        public int getId()
          throws DecodeException
        Gets the value of local mobile station identifier.
        Returns:
        int representation of local mobile station identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

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

      • 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:
        4, or 0 if encoded value is not long enough