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

Class IMEIAddress

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class IMEIAddress
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class IMEIAddress represents both the IMEI and IMEISV types as defined in 3GPP TS 23.003. An IMEI address is 15 or 16 digits, comprising:

• type allocation code (TAC), which is 8 digits;
• serial number (SNR), which is 6 digits;
• IMEISV: software version number (SVN), which is 2 digits
• IMEI: check digit (CD)/spare digit (SD)

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

 IMEI ::= SEQUENCE {
    address DigitString
 }

(The TAC, SNR and SVN/SD/CD are not separated in this class.) The class takes care of encoding the field values into a byte-array and decoding the 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) §6.2 p26-27
	8	7	6	5	4	3	2	1
Octet 0	TAC digit 2				TAC digit 1
Octet 1	TAC digit 4				TAC digit 3
Octet 2	TAC digit 6				TAC digit 5
Octet 3	TAC digit 8				TAC digit 7
Octet 4	SNR digit 2				SNR digit 1
Octet 5	SNR digit 4				SNR digit 3
Octet 6	SNR digit 6				SNR digit 5
Octet 7	SVN digit 2/Filler				SVN digit 1/Check Digit

The length of the data encoding is 8 octets.

Each digit of the address fields is encoded into a semi-octet. Unless overridden by a particular StringCodec, the filler is 0xF and the encoding to semi-octets is as tabulated below.

Decoded character	0	1	2	3	4	5	6	7	8	9
Encoded hexadecimal	0	1	2	3	4	5	6	7	8	9	A	B	C	D	E	F

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BCDStringCodec<IMEIAddress>	ADDRESS_CODEC BCD string codec for field Address.

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
IMEIAddress() Constructs a new IMEIAddress object with no fields set.
IMEIAddress(byte[] data) Constructs a new IMEIAddress object from network-encoded data.
IMEIAddress(byte[] data, int start, int len) Constructs a new IMEIAddress object from part of network-encoded data.
IMEIAddress(DataInput in) Constructs a new IMEIAddress object from data deserialized from a stream that was written by toStream(DataOutput).
IMEIAddress(String address) Constructs a new IMEIAddress object from given values for all fields.
IMEIAddress(String address, StringCodec<IMEIAddress> Address_codec) Constructs a new IMEIAddress object from given arguments, using the given codecs for encoding fields of type String.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
IMEIAddress	clone() Constructs a copy of this object and everything reachable from it.
static IMEIAddress	copyOf(IMEIAddress 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.
String	getAddress() Gets the value of the IMEI address.
String	getAddress(StringCodec<IMEIAddress> codec) Gets the value of the IMEI address using the given codec.
StringCodec<IMEIAddress>	getAddressCodec() Gets the codec used for field Address.
byte[]	getAddressEncoded() Gets a clone of the encoded value of the IMEI address.
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.
boolean	hasAddress() Tests whether the field Address has a value.
IMEIAddress	setAddress(String value) Sets the value of the IMEI address.
IMEIAddress	setAddress(String value, StringCodec<IMEIAddress> codec) Sets the value of the IMEI address using the given codec.
IMEIAddress	setAddressEncoded(byte[] encoded) Sets the encoded value of the IMEI address to a clone of the given byte array.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by IMEIAddress(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

Field Detail

ADDRESS_CODEC

public static final BCDStringCodec<IMEIAddress> ADDRESS_CODEC

BCD string codec for field Address.

Constructor Detail

IMEIAddress

public IMEIAddress()

Constructs a new IMEIAddress object with no fields set.

IMEIAddress

public IMEIAddress(byte[] data)

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

IMEIAddress

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

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

IMEIAddress

public IMEIAddress(String address)

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

Parameters:

address - the IMEI address

IMEIAddress

public IMEIAddress(String address,
           StringCodec<IMEIAddress> Address_codec)

Constructs a new IMEIAddress object from given arguments, using the given codecs for encoding fields of type String.

Parameters:

address - the IMEI address

Address_codec - StringCodec for address

IMEIAddress

public IMEIAddress(DataInput in)
            throws IOException

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

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasAddress

public boolean hasAddress()
                   throws DecodeException

Tests whether the field Address 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

getAddress

public String getAddress()
                  throws DecodeException

Gets the value of the IMEI address. Equivalent to getAddress(null).

Returns:

String representation of the IMEI address

Throws:

DecodeException - if encoded state cannot be decoded

setAddress

public IMEIAddress setAddress(String value)
                       throws IllegalStateException

Sets the value of the IMEI address.

Parameters:

value - String representation of the IMEI address

Returns:

this

Throws:

IllegalStateException

getAddress

public String getAddress(StringCodec<IMEIAddress> codec)
                  throws DecodeException

Gets the value of the IMEI address using the given codec. If the field Address 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 IMEI address

Throws:

DecodeException - if encoded state cannot be decoded

getAddressEncoded

public byte[] getAddressEncoded()

Gets a clone of the encoded value of the IMEI address.

Returns:

byte[] representation of the IMEI address

setAddress

public IMEIAddress setAddress(String value,
                     StringCodec<IMEIAddress> codec)
                       throws IllegalArgumentException

Sets the value of the IMEI address using the given codec. If the given codec is null, uses the standard codec.

Parameters:

value - String representation of the IMEI address

codec - StringCodec to use for encoding

Returns:

this

Throws:

IllegalArgumentException

setAddressEncoded

public IMEIAddress setAddressEncoded(byte[] encoded)

Sets the encoded value of the IMEI address to a clone of the given byte array.

Parameters:

encoded - byte[] representation of the IMEI address

Returns:

this

copyOf

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

IMEIAddress

clone

public IMEIAddress 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

getAddressCodec

public StringCodec<IMEIAddress> getAddressCodec()

Gets the codec used for field Address.

Returns:

StringCodec

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if the address is not 15 or 16 digits

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if number of octets to be decoded is not 8