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

Class LMSIAddress

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.cc.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
	8	7	6	5	4	3	2	1
Octet 0	Id
Octet 1
Octet 2
Octet 3

See Also:

Serialized Form

Field Summary

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
LMSIAddress() Constructs a new LMSIAddress object with no fields set.
LMSIAddress(byte[] data) Constructs a new LMSIAddress object from network-encoded data.
LMSIAddress(byte[] data, int start, int len) Constructs a new LMSIAddress object from part of network-encoded data.
LMSIAddress(DataInput in) Constructs a new LMSIAddress object from data deserialized from a stream that was written by toStream(DataOutput).
LMSIAddress(int id) Constructs a new LMSIAddress object from given values for all fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
LMSIAddress	clone() Constructs a copy of this object and everything reachable from it.
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.
protected void	decode() Computes the decoded form from the encoded form.
protected void	encode() Computes the encoded form from the decoded form.
protected boolean	encodedIsInvalid() Determines whether the encoded form is invalid.
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.
byte[]	getEncodedForm() Gets the encoded form.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value for the fields of a sequence.
int	getId() Gets the value of local mobile station identifier.
boolean	hasId() Tests whether the field Id has a value.
LMSIAddress	setId(int value) Sets the value of local mobile station identifier.
LMSIAddress	setIdPresent(boolean flag) Sets the presence or absence of the field Id.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by LMSIAddress(DataInput).

Methods inherited from class AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by LMSIAddress(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

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

checkFieldsSet

public void checkFieldsSet()
                    throws EncodeException

Checks that all mandatory fields are present. Should be called immediately before all calls to encode().

Specified by:

checkFieldsSet in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if any mandatory field is not present

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

setId

public LMSIAddress setId(int value)
                  throws IllegalStateException

Sets the value of local mobile station identifier.

Parameters:

value - int representation of local mobile station identifier

Returns:

this

Throws:

IllegalStateException

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

clone

public LMSIAddress clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

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

encode

protected void encode()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if not 4 octets to be decoded