Package com.opencloud.slee.resources.cgin.map

Class MAPArea

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPArea

All Implemented Interfaces:

DataObject, Serializable

public class MAPArea
extends AbstractFieldsObject

API for MAP-LCS-DataTypes.Area. Generated from the following ASN.1 type definition.

 Area ::=
     SEQUENCE {
         areaType           AreaType,
         areaIdentification AreaIdentification,
         ...
     }
 

Added in release 6.

Used in array as field type by MAPAreaDefinition.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
MAPArea()	Constructs an object with uninitialised state.
MAPArea(MAPAreaType AreaType_param, byte[] AreaIdentification_param)	Constructs an object from given values for all fields.

Method Summary

Modifier and Type	Method	Description
MAPArea	clone()	Constructs a copy of this object and everything reachable from it.
static MAPArea	copyOf(MAPArea 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.
byte[]	getAreaIdentification()	Gets the value of the field areaIdentification.
MAPAreaType	getAreaType()	Gets the value of the field areaType.
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.
boolean	hasAreaIdentification()	Tests whether the field areaIdentification has a value.
boolean	hasAreaType()	Tests whether the field areaType has a value.
MAPArea	setAreaIdentification(byte[] value)	Sets the value of the field areaIdentification.
MAPArea	setAreaType(MAPAreaType value)	Sets the value of the field areaType.

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

MAPArea

public MAPArea()

Constructs an object with uninitialised state.

MAPArea

public MAPArea(MAPAreaType AreaType_param,
               byte[] AreaIdentification_param)

Constructs an object from given values for all fields.

Parameters:

AreaType_param - value for that field

AreaIdentification_param - value for that field

Method Detail

clone

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

MAPArea

getAreaIdentification

public byte[] getAreaIdentification()

Gets the value of the field areaIdentification.

Returns:

value of field areaIdentification, or null if not present

getAreaType

public MAPAreaType getAreaType()

Gets the value of the field areaType.

Returns:

value of field areaType, or null if not present

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 a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

hasAreaIdentification

public boolean hasAreaIdentification()

Tests whether the field areaIdentification has a value.

Returns:

whether the field areaIdentification has a value

hasAreaType

public boolean hasAreaType()

Tests whether the field areaType has a value.

Returns:

whether the field areaType has a value

setAreaIdentification

public MAPArea setAreaIdentification(byte[] value)
                              throws IllegalStateException

Sets the value of the field areaIdentification.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setAreaType

public MAPArea setAreaType(MAPAreaType value)
                    throws IllegalStateException

Sets the value of the field areaType.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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