Class MSClassmark

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable

    public final class MSClassmark
    extends AbstractLazyEncodedByteArray
    implements FastSerializable
    Class MSClassmark represents a Mobile Station Classmark, which provides the network with information concerning aspects of high priority of the mobile station equipment. Three formats of MSClassmark are defined in 3GPP TS 24.008 v9.3.0.

    The API offered by this class is as if the type were specified in ASN.1 as follows. Helper APIs are defined in nested classes for two of the three formats.

     MSClassmark ::= CHOICE {
         mSClassmark1  MSClassmark1,
         mSClassmark2  MSClassmark2,
         mSClassmark3  OCTET STRING
     }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • MSClassmark

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

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

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

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

      • isMSClassmark1Chosen

        public boolean isMSClassmark1Chosen()
                                     throws DecodeException
        Tests whether the choice is mSClassmark1.
        Returns:
        true if chosen, false if not
        Throws:
        DecodeException - if encoded state cannot be decoded
      • isMSClassmark2Chosen

        public boolean isMSClassmark2Chosen()
                                     throws DecodeException
        Tests whether the choice is mSClassmark2.
        Returns:
        true if chosen, false if not
        Throws:
        DecodeException - if encoded state cannot be decoded
      • isMSClassmark3Chosen

        public boolean isMSClassmark3Chosen()
                                     throws DecodeException
        Tests whether the choice is mSClassmark3.
        Returns:
        true if chosen, false if not
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getMSClassmark1

        public MSClassmark.MSClassmark1 getMSClassmark1()
                                                 throws DecodeException
        Gets the value of MS Classmark 1.
        Returns:
        MSClassmark1 representation of MS Classmark 1, if choice is MS Classmark 1, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getMSClassmark2

        public MSClassmark.MSClassmark2 getMSClassmark2()
                                                 throws DecodeException
        Gets the value of MS Classmark 2.
        Returns:
        MSClassmark2 representation of MS Classmark 2, if choice is MS Classmark 2, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getMSClassmark3

        public byte[] getMSClassmark3()
                               throws DecodeException
        Gets the value of MS Classmark 3.
        Returns:
        byte[] representation of MS Classmark 3, if choice is MS Classmark 3, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • copyOf

        public static MSClassmark copyOf​(MSClassmark 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:
        MSClassmark
      • 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 :discriminant-name to field-value. If choice is not set, returns a Map from : to AbstractFieldsObject.FIELD_UNINITIALISED. For a field of primitive type, the field-value is boxed. 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 - the value of this parameter is ignored
        Returns:
        Map from :discriminant-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