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

Class CalledPartyNumber

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class CalledPartyNumber
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class CalledPartyNumber identifies the party to be called. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.CalledPartyNumber.

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

 CalledPartyNumber ::= SEQUENCE {
     nature                         Nature,
     routingToInternalNetworkNumber RoutingToInternalNetworkNumber,
     numberingPlan                  NumberingPlan,
     address                        DigitString
 }

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 ITU-T Q.763 (12/1999) §3.9 p22
	8	7	6	5	4	3	2	1
Octet 1	Odd?	Nature of address
Octet 2	Routing to internal network number	Numbering plan			Spare
Octet 2+1	Address digit 2				Address digit 1
...	...				...
Octet 2+n	Filler (0000) or Address digit 2n				Address digit 2n-1

The length of the data encoding depends on the length of the address. The octet numbering in the above table is based on that used in the cited standard, tweaked to ease specification of the address encoding. Field names ending in ? are booleans: 1 for true, 0 for false.

Each digit of the address field is encoded into a semi-octet, and if there is an odd number of digits then the last semi-octet is assigned a filler. Unless overridden by a particular StringCodec, the filler is 0 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalledPartyNumber.Nature Nature-of-address indicator constants.
static class	CalledPartyNumber.NumberingPlan Enumeration of Numbering Plan indicator constants.
static class	CalledPartyNumber.RoutingToInternalNetworkNumber Enumeration of Routing To Internal Network Number constants.

Field Summary

Fields

Modifier and Type	Field and Description
static BCDStringCodec<CalledPartyNumber>	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
CalledPartyNumber() Constructs a new CalledPartyNumber object with no fields set.
CalledPartyNumber(byte[] data) Constructs a new CalledPartyNumber object from network-encoded data.
CalledPartyNumber(byte[] data, int start, int len) Constructs a new CalledPartyNumber object from part of network-encoded data.
CalledPartyNumber(CalledPartyNumber.Nature nature, CalledPartyNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber, CalledPartyNumber.NumberingPlan numberingPlan, String address) Constructs a new CalledPartyNumber object from given values for all fields.
CalledPartyNumber(CalledPartyNumber.Nature nature, CalledPartyNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber, CalledPartyNumber.NumberingPlan numberingPlan, String address, StringCodec<CalledPartyNumber> Address_codec) Constructs a new CalledPartyNumber object from given arguments, using the given codecs for encoding fields of type String.
CalledPartyNumber(DataInput in) Constructs a new CalledPartyNumber object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
CalledPartyNumber	clone() Constructs a copy of this object and everything reachable from it.
static CalledPartyNumber	copyOf(CalledPartyNumber 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 number digits.
String	getAddress(StringCodec<CalledPartyNumber> codec) Gets the value of the number digits using the given codec.
StringCodec<CalledPartyNumber>	getAddressCodec() Gets the codec used for field Address.
EncodedStringWithIndicators	getAddressEncoded() Gets a clone of the encoded value of the number digits.
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.
CalledPartyNumber.Nature	getNature() Gets the value of the nature of address indicator.
CalledPartyNumber.NumberingPlan	getNumberingPlan() Gets the value of the numbering plan indicator.
CalledPartyNumber.RoutingToInternalNetworkNumber	getRoutingToInternalNetworkNumber() Gets the value of the internal network number indicator (INN).
boolean	hasAddress() Tests whether the field Address has a value.
boolean	hasNature() Tests whether the field Nature has a value.
boolean	hasNumberingPlan() Tests whether the field NumberingPlan has a value.
boolean	hasRoutingToInternalNetworkNumber() Tests whether the field RoutingToInternalNetworkNumber has a value.
CalledPartyNumber	setAddress(String value) Sets the value of the number digits.
CalledPartyNumber	setAddress(String value, StringCodec<CalledPartyNumber> codec) Sets the value of the number digits using the given codec.
CalledPartyNumber	setAddressEncoded(EncodedStringWithIndicators encoded) Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.
CalledPartyNumber	setNature(CalledPartyNumber.Nature value) Sets the value of the nature of address indicator.
CalledPartyNumber	setNumberingPlan(CalledPartyNumber.NumberingPlan value) Sets the value of the numbering plan indicator.
CalledPartyNumber	setRoutingToInternalNetworkNumber(CalledPartyNumber.RoutingToInternalNetworkNumber value) Sets the value of the internal network number indicator (INN).
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by CalledPartyNumber(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<CalledPartyNumber> ADDRESS_CODEC

BCD string codec for field Address.

Constructor Detail

CalledPartyNumber

public CalledPartyNumber()

Constructs a new CalledPartyNumber object with no fields set.

CalledPartyNumber

public CalledPartyNumber(byte[] data)

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

CalledPartyNumber

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

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

CalledPartyNumber

public CalledPartyNumber(CalledPartyNumber.Nature nature,
                 CalledPartyNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber,
                 CalledPartyNumber.NumberingPlan numberingPlan,
                 String address)

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

Parameters:

nature - the nature of address indicator

routingToInternalNetworkNumber - the internal network number indicator (INN)

numberingPlan - the numbering plan indicator

address - the number digits

CalledPartyNumber

public CalledPartyNumber(CalledPartyNumber.Nature nature,
                 CalledPartyNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber,
                 CalledPartyNumber.NumberingPlan numberingPlan,
                 String address,
                 StringCodec<CalledPartyNumber> Address_codec)

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

Parameters:

nature - the nature of address indicator

routingToInternalNetworkNumber - the internal network number indicator (INN)

numberingPlan - the numbering plan indicator

address - the number digits

Address_codec - StringCodec for address

CalledPartyNumber

public CalledPartyNumber(DataInput in)
                  throws IOException

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

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasNature

public boolean hasNature()
                  throws DecodeException

Tests whether the field Nature has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasRoutingToInternalNetworkNumber

public boolean hasRoutingToInternalNetworkNumber()
                                          throws DecodeException

Tests whether the field RoutingToInternalNetworkNumber has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasNumberingPlan

public boolean hasNumberingPlan()
                         throws DecodeException

Tests whether the field NumberingPlan has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

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

getNature

public CalledPartyNumber.Nature getNature()
                                   throws DecodeException

Gets the value of the nature of address indicator.

Returns:

Nature representation of the nature of address indicator

Throws:

DecodeException - if encoded state cannot be decoded

getRoutingToInternalNetworkNumber

public CalledPartyNumber.RoutingToInternalNetworkNumber getRoutingToInternalNetworkNumber()
                                                                                   throws DecodeException

Gets the value of the internal network number indicator (INN).

Returns:

RoutingToInternalNetworkNumber representation of the internal network number indicator (INN)

Throws:

DecodeException - if encoded state cannot be decoded

getNumberingPlan

public CalledPartyNumber.NumberingPlan getNumberingPlan()
                                                 throws DecodeException

Gets the value of the numbering plan indicator.

Returns:

NumberingPlan representation of the numbering plan indicator

Throws:

DecodeException - if encoded state cannot be decoded

getAddress

public String getAddress()
                  throws DecodeException

Gets the value of the number digits. Equivalent to getAddress(null).

Returns:

String representation of the number digits

Throws:

DecodeException - if encoded state cannot be decoded

setNature

public CalledPartyNumber setNature(CalledPartyNumber.Nature value)
                            throws IllegalStateException

Sets the value of the nature of address indicator.

Parameters:

value - Nature representation of the nature of address indicator

Returns:

this

Throws:

IllegalStateException

setRoutingToInternalNetworkNumber

public CalledPartyNumber setRoutingToInternalNetworkNumber(CalledPartyNumber.RoutingToInternalNetworkNumber value)
                                                    throws IllegalStateException

Sets the value of the internal network number indicator (INN).

Parameters:

value - RoutingToInternalNetworkNumber representation of the internal network number indicator (INN)

Returns:

this

Throws:

IllegalStateException

setNumberingPlan

public CalledPartyNumber setNumberingPlan(CalledPartyNumber.NumberingPlan value)
                                   throws IllegalStateException

Sets the value of the numbering plan indicator.

Parameters:

value - NumberingPlan representation of the numbering plan indicator

Returns:

this

Throws:

IllegalStateException

setAddress

public CalledPartyNumber setAddress(String value)
                             throws IllegalStateException

Sets the value of the number digits.

Parameters:

value - String representation of the number digits

Returns:

this

Throws:

IllegalStateException

getAddress

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

Gets the value of the number digits 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 number digits

Throws:

DecodeException - if encoded state cannot be decoded

getAddressEncoded

public EncodedStringWithIndicators getAddressEncoded()

Gets a clone of the encoded value of the number digits.

Returns:

EncodedStringWithIndicators representation of the number digits

setAddress

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

Sets the value of the number digits using the given codec. If the given codec is null, uses the standard codec.

Parameters:

value - String representation of the number digits

codec - StringCodec to use for encoding

Returns:

this

Throws:

IllegalArgumentException

setAddressEncoded

public CalledPartyNumber setAddressEncoded(EncodedStringWithIndicators encoded)

Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.

Parameters:

encoded - EncodedStringWithIndicators representation of the number digits

Returns:

this

copyOf

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

CalledPartyNumber

clone

public CalledPartyNumber 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 variable length, so the given 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:

len, or 0 if encoded value is not long enough

getAddressCodec

public StringCodec<CalledPartyNumber> getAddressCodec()

Gets the codec used for field Address.

Returns:

StringCodec

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 less than 2 octets to be decoded