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

Class LocalisedServiceAreaId

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class LocalisedServiceAreaId
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class LocalisedServiceAreaId identifies a cell's Localised Service Area (LSA). It represents the ASN.1 OCTET STRING type MAP-MS-DataTypes.LSAIdentity.

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

 LocalisedServiceAreaId ::= SEQUENCE {
     localisedServiceAreaId INTEGER,
     addressType            AddressType
 }

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) §11 pp36-37
	8	7	6	5	4	3	2	1
Octet 0	Localised service area id bits 23 .. 16
Octet 1	Localised service area id bits 15 .. 8
Octet 2	Localised service area id bits 7 .. 1							Address type

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalisedServiceAreaId.AddressType Enumeration of Address Type constants.

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
LocalisedServiceAreaId() Constructs a new LocalisedServiceAreaId object with no fields set.
LocalisedServiceAreaId(byte[] data) Constructs a new LocalisedServiceAreaId object from network-encoded data.
LocalisedServiceAreaId(byte[] data, int start, int len) Constructs a new LocalisedServiceAreaId object from part of network-encoded data.
LocalisedServiceAreaId(DataInput in) Constructs a new LocalisedServiceAreaId object from data deserialized from a stream that was written by toStream(DataOutput).
LocalisedServiceAreaId(int localisedServiceAreaId, LocalisedServiceAreaId.AddressType addressType) Constructs a new LocalisedServiceAreaId 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.
LocalisedServiceAreaId	clone() Constructs a copy of this object and everything reachable from it.
static LocalisedServiceAreaId	copyOf(LocalisedServiceAreaId 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.
LocalisedServiceAreaId.AddressType	getAddressType() Gets the value of whether PLMN or universal LSA.
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	getLocalisedServiceAreaId() Gets the value of 23 bits of localised service area id.
boolean	hasAddressType() Tests whether the field AddressType has a value.
boolean	hasLocalisedServiceAreaId() Tests whether the field LocalisedServiceAreaId has a value.
LocalisedServiceAreaId	setAddressType(LocalisedServiceAreaId.AddressType value) Sets the value of whether PLMN or universal LSA.
LocalisedServiceAreaId	setLocalisedServiceAreaId(int value) Sets the value of 23 bits of localised service area id.
LocalisedServiceAreaId	setLocalisedServiceAreaIdPresent(boolean flag) Sets the presence or absence of the field LocalisedServiceAreaId.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by LocalisedServiceAreaId(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

LocalisedServiceAreaId

public LocalisedServiceAreaId()

Constructs a new LocalisedServiceAreaId object with no fields set.

LocalisedServiceAreaId

public LocalisedServiceAreaId(byte[] data)

Constructs a new LocalisedServiceAreaId 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

LocalisedServiceAreaId

public LocalisedServiceAreaId(byte[] data,
                      int start,
                      int len)

Constructs a new LocalisedServiceAreaId 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

LocalisedServiceAreaId

public LocalisedServiceAreaId(int localisedServiceAreaId,
                      LocalisedServiceAreaId.AddressType addressType)

Constructs a new LocalisedServiceAreaId object from given values for all fields.

Parameters:

localisedServiceAreaId - 23 bits of localised service area id

addressType - whether PLMN or universal LSA

LocalisedServiceAreaId

public LocalisedServiceAreaId(DataInput in)
                       throws IOException

Constructs a new LocalisedServiceAreaId 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 LocalisedServiceAreaId(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasLocalisedServiceAreaId

public boolean hasLocalisedServiceAreaId()
                                  throws DecodeException

Tests whether the field LocalisedServiceAreaId has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setLocalisedServiceAreaIdPresent

public LocalisedServiceAreaId setLocalisedServiceAreaIdPresent(boolean flag)
                                                        throws IllegalStateException

Sets the presence or absence of the field LocalisedServiceAreaId.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

hasAddressType

public boolean hasAddressType()
                       throws DecodeException

Tests whether the field AddressType has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

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

getLocalisedServiceAreaId

public int getLocalisedServiceAreaId()
                              throws DecodeException

Gets the value of 23 bits of localised service area id.

Returns:

int representation of 23 bits of localised service area id

Throws:

DecodeException - if encoded state cannot be decoded

getAddressType

public LocalisedServiceAreaId.AddressType getAddressType()
                                                  throws DecodeException

Gets the value of whether PLMN or universal LSA.

Returns:

AddressType representation of whether PLMN or universal LSA

Throws:

DecodeException - if encoded state cannot be decoded

setLocalisedServiceAreaId

public LocalisedServiceAreaId setLocalisedServiceAreaId(int value)
                                                 throws IllegalStateException

Sets the value of 23 bits of localised service area id.

Parameters:

value - int representation of 23 bits of localised service area id

Returns:

this

Throws:

IllegalStateException

setAddressType

public LocalisedServiceAreaId setAddressType(LocalisedServiceAreaId.AddressType value)
                                      throws IllegalStateException

Sets the value of whether PLMN or universal LSA.

Parameters:

value - AddressType representation of whether PLMN or universal LSA

Returns:

this

Throws:

IllegalStateException

copyOf

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

LocalisedServiceAreaId

clone

public LocalisedServiceAreaId 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:

3, or 0 if encoded value is not long enough

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if LocalisedServiceAreaId is out of range [0,8388607]

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 3 octets to be decoded