com.opencloud.slee.resources.cgin.map

Class MAPSubscriberId

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPSubscriberId

All Implemented Interfaces:

DataObject, Serializable

public class MAPSubscriberId
extends AbstractFieldsObject

API for MAP-CommonDataTypes.SubscriberId. Generated from the following ASN.1 type definition.

 SubscriberId ::=
     CHOICE {
         imsi IMSI,
         tmsi TMSI
     }
 

Present in ph1. Unused since ph2, but its definition has not yet been removed.

Used as field type by MAPSendParametersArg.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MAPSubscriberId.Choice API for MAP-CommonDataTypes.SubscriberId.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MAPSubscriberId()

Method Summary

Methods

Modifier and Type	Method and Description
MAPSubscriberId	clone() Constructs a copy of this object and everything reachable from it.
static MAPSubscriberId	copyOf(MAPSubscriberId 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.
MAPSubscriberId.Choice	getChoice() Gets the discriminant of the current choice.
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 :discriminant-name to associated-value.
IMSIAddress	getImsi() Gets the value of the imsi choice.
byte[]	getTmsi() Gets the value of the tmsi choice.
boolean	isImsiChosen() Tests whether the choice is imsi.
boolean	isTmsiChosen() Tests whether the choice is tmsi.
MAPSubscriberId	setImsi(IMSIAddress value) Sets the value of the imsi choice.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPSubscriberId	setTmsi(byte[] value) Sets the value of the tmsi choice.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

MAPSubscriberId

public MAPSubscriberId()

Method Detail

clone

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

copyOf

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

MAPSubscriberId

getChoice

public MAPSubscriberId.Choice getChoice()

Gets the discriminant of the current choice.

Returns:

the current discriminant

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 associated-value. For a value of primitive type, the value is boxed. If choice is not set, returns a map from : to AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - ignored, as value cannot be optional

Returns:

Map from :discriminant-name to associated-value

getImsi

public IMSIAddress getImsi()

Gets the value of the imsi choice.

Returns:

value of the choice, if choice is imsi, else null

getTmsi

public byte[] getTmsi()

Gets the value of the tmsi choice.

Returns:

value of the choice, if choice is tmsi, else null

isImsiChosen

public boolean isImsiChosen()

Tests whether the choice is imsi.

Returns:

true if chosen, false if not

isTmsiChosen

public boolean isTmsiChosen()

Tests whether the choice is tmsi.

Returns:

true if chosen, false if not

setImsi

public MAPSubscriberId setImsi(IMSIAddress value)
                        throws IllegalStateException,
                               NullPointerException

Sets the value of the imsi choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setTmsi

public MAPSubscriberId setTmsi(byte[] value)
                        throws IllegalStateException,
                               NullPointerException

Sets the value of the tmsi choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null