CallingPartyNumber (CGIN Unified RA API (1.5.4.7))

java.lang.Object
- com.opencloud.util.AbstractDataObject
- - com.opencloud.util.AbstractFieldsObject
  - - AbstractEncodedDataObject<T>
    - - AbstractLazyEncodedDataObject<byte[]>
      - AbstractLazyEncodedByteArray
        
        com.opencloud.slee.resources.in.datatypes.cc.CallingPartyNumber

All Implemented Interfaces:: DataObject, FastSerializable, Serializable

public class CallingPartyNumber
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class CallingPartyNumber represents the address of the calling party. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.CallingPartyNumber.

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

 CallingPartyNumber ::= SEQUENCE {
     nature           Nature,
     numberIncomplete BOOLEAN,
     numberingPlan    NumberingPlan,
     presentation     Presentation,
     screening        Screening,
     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.10 p24
	8	7	6	5	4	3	2	1
Octet 1	Odd?	Nature of address
Octet 2	Number incomplete?	Numbering plan			Address presentation restricted		Screening
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. Since 0 is also the encoding of a valid digit, a separate indicator is required to encode whether there is an odd number of digits or not.

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`	`CallingPartyNumber.Nature` Nature-of-address indicator constants.
`static class`	`CallingPartyNumber.NumberingPlan` Enumeration of Numbering Plan indicator constants.
`static class`	`CallingPartyNumber.Presentation` Enumeration of Address Presentation Restricted indicator constants.
`static class`	`CallingPartyNumber.Screening` Enumeration of Screening indicator constants.

Field Summary

Fields
Modifier and Type	Field and Description
`static BCDStringCodec<CallingPartyNumber>`	`ADDRESS_CODEC` BCD string codec for field Address.
`protected EncodedStringWithIndicators`	`Address_value` Encoded form of field Address.
`protected CallingPartyNumber.Nature`	`Nature_value` Value of field Nature.
`protected boolean`	`NumberIncomplete_present` Whether field NumberIncomplete is present.
`protected boolean`	`NumberIncomplete_value` Value of field NumberIncomplete.
`protected CallingPartyNumber.NumberingPlan`	`NumberingPlan_value` Value of field NumberingPlan.
`protected CallingPartyNumber.Presentation`	`Presentation_value` Value of field Presentation.
`protected CallingPartyNumber.Screening`	`Screening_value` Value of field Screening.

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
`CallingPartyNumber()` Constructs a new CallingPartyNumber object with no fields set.
`CallingPartyNumber(byte[] data)` Constructs a new CallingPartyNumber object from network-encoded data.
`CallingPartyNumber(byte[] data, int start, int len)` Constructs a new CallingPartyNumber object from part of network-encoded data.
`CallingPartyNumber(CallingPartyNumber.Nature nature, boolean numberIncomplete, CallingPartyNumber.NumberingPlan numberingPlan, CallingPartyNumber.Presentation presentation, CallingPartyNumber.Screening screening, String address)` Constructs a new CallingPartyNumber object from given values for all fields.
`CallingPartyNumber(CallingPartyNumber.Nature nature, boolean numberIncomplete, CallingPartyNumber.NumberingPlan numberingPlan, CallingPartyNumber.Presentation presentation, CallingPartyNumber.Screening screening, String address, StringCodec<CallingPartyNumber> Address_codec)` Constructs a new CallingPartyNumber object from given arguments, using the given codecs for encoding fields of type String.
`CallingPartyNumber(DataInput in)` Constructs a new CallingPartyNumber 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.
`CallingPartyNumber`	`clone()` Constructs a copy of this object and everything reachable from it.
`static CallingPartyNumber`	`copyOf(CallingPartyNumber 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<CallingPartyNumber> codec)` Gets the value of the number digits using the given codec.
`StringCodec<CallingPartyNumber>`	`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.
`CallingPartyNumber.Nature`	`getNature()` Gets the value of the nature of address.
`boolean`	`getNumberIncomplete()` Gets the value of the number incomplete indicator.
`CallingPartyNumber.NumberingPlan`	`getNumberingPlan()` Gets the value of the numbering plan indicator.
`CallingPartyNumber.Presentation`	`getPresentation()` Gets the value of the address presentation restricted indicator.
`CallingPartyNumber.Screening`	`getScreening()` Gets the value of the screening indicator.
`boolean`	`hasAddress()` Tests whether the field Address has a value.
`boolean`	`hasNature()` Tests whether the field Nature has a value.
`boolean`	`hasNumberIncomplete()` Tests whether the field NumberIncomplete has a value.
`boolean`	`hasNumberingPlan()` Tests whether the field NumberingPlan has a value.
`boolean`	`hasPresentation()` Tests whether the field Presentation has a value.
`boolean`	`hasScreening()` Tests whether the field Screening has a value.
`CallingPartyNumber`	`setAddress(String value)` Sets the value of the number digits.
`CallingPartyNumber`	`setAddress(String value, StringCodec<CallingPartyNumber> codec)` Sets the value of the number digits using the given codec.
`CallingPartyNumber`	`setAddressEncoded(EncodedStringWithIndicators encoded)` Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.
`CallingPartyNumber`	`setNature(CallingPartyNumber.Nature value)` Sets the value of the nature of address.
`CallingPartyNumber`	`setNumberIncomplete(boolean value)` Sets the value of the number incomplete indicator.
`CallingPartyNumber`	`setNumberIncompletePresent(boolean flag)` Sets the presence or absence of the field NumberIncomplete.
`CallingPartyNumber`	`setNumberingPlan(CallingPartyNumber.NumberingPlan value)` Sets the value of the numbering plan indicator.
`CallingPartyNumber`	`setPresentation(CallingPartyNumber.Presentation value)` Sets the value of the address presentation restricted indicator.
`CallingPartyNumber`	`setScreening(CallingPartyNumber.Screening value)` Sets the value of the screening indicator.
`void`	`toStream(DataOutput out)` Serializes this object to a stream in a form suitable for reading by `CallingPartyNumber(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<CallingPartyNumber> ADDRESS_CODEC
```
    BCD string codec for field Address.
  - Nature_value
```
protected CallingPartyNumber.Nature Nature_value
```
    Value of field Nature.
  - NumberIncomplete_value
```
protected boolean NumberIncomplete_value
```
    Value of field NumberIncomplete.
  - NumberIncomplete_present
```
protected boolean NumberIncomplete_present
```
    Whether field NumberIncomplete is present.
  - NumberingPlan_value
```
protected CallingPartyNumber.NumberingPlan NumberingPlan_value
```
    Value of field NumberingPlan.
  - Presentation_value
```
protected CallingPartyNumber.Presentation Presentation_value
```
    Value of field Presentation.
  - Screening_value
```
protected CallingPartyNumber.Screening Screening_value
```
    Value of field Screening.
  - Address_value
```
protected EncodedStringWithIndicators Address_value
```
    Encoded form of field Address.
- Constructor Detail
  - CallingPartyNumber
```
public CallingPartyNumber()
```
    Constructs a new CallingPartyNumber object with no fields set.
  - CallingPartyNumber
```
public CallingPartyNumber(byte[] data)
```
    Constructs a new CallingPartyNumber 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
  - CallingPartyNumber
```
public CallingPartyNumber(byte[] data,
                  int start,
                  int len)
```
    Constructs a new CallingPartyNumber 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
  - CallingPartyNumber
```
public CallingPartyNumber(CallingPartyNumber.Nature nature,
                  boolean numberIncomplete,
                  CallingPartyNumber.NumberingPlan numberingPlan,
                  CallingPartyNumber.Presentation presentation,
                  CallingPartyNumber.Screening screening,
                  String address)
```
    Constructs a new CallingPartyNumber object from given values for all fields.
    
    Parameters:
    nature - the nature of address
    numberIncomplete - the number incomplete indicator
    numberingPlan - the numbering plan indicator
    presentation - the address presentation restricted indicator
    screening - the screening indicator
    address - the number digits
  - CallingPartyNumber
```
public CallingPartyNumber(CallingPartyNumber.Nature nature,
                  boolean numberIncomplete,
                  CallingPartyNumber.NumberingPlan numberingPlan,
                  CallingPartyNumber.Presentation presentation,
                  CallingPartyNumber.Screening screening,
                  String address,
                  StringCodec<CallingPartyNumber> Address_codec)
```
    Constructs a new CallingPartyNumber object from given arguments, using the given codecs for encoding fields of type String.
    
    Parameters:
    nature - the nature of address
    numberIncomplete - the number incomplete indicator
    numberingPlan - the numbering plan indicator
    presentation - the address presentation restricted indicator
    screening - the screening indicator
    address - the number digits
    Address_codec - StringCodec for address
  - CallingPartyNumber
```
public CallingPartyNumber(DataInput in)
                   throws IOException
```
    Constructs a new CallingPartyNumber 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 CallingPartyNumber(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
  - hasNumberIncomplete
```
public boolean hasNumberIncomplete()
                            throws DecodeException
```
    Tests whether the field NumberIncomplete has a value.
    
    Returns:
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - setNumberIncompletePresent
```
public CallingPartyNumber setNumberIncompletePresent(boolean flag)
                                              throws IllegalStateException
```
    Sets the presence or absence of the field NumberIncomplete.
    
    Parameters:
    flag - whether the field should be marked as present
    
    Returns:
    this
    
    Throws:
    
    IllegalStateException - if this instance has been marked as read-only
  - 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
  - hasPresentation
```
public boolean hasPresentation()
                        throws DecodeException
```
    Tests whether the field Presentation has a value.
    
    Returns:
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasScreening
```
public boolean hasScreening()
                     throws DecodeException
```
    Tests whether the field Screening 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 CallingPartyNumber.Nature getNature()
                                    throws DecodeException
```
    Gets the value of the nature of address.
    
    Returns:
    Nature representation of the nature of address
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getNumberIncomplete
```
public boolean getNumberIncomplete()
                            throws DecodeException
```
    Gets the value of the number incomplete indicator.
    
    Returns:
    boolean representation of the number incomplete indicator
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getNumberingPlan
```
public CallingPartyNumber.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
  - getPresentation
```
public CallingPartyNumber.Presentation getPresentation()
                                                throws DecodeException
```
    Gets the value of the address presentation restricted indicator.
    
    Returns:
    Presentation representation of the address presentation restricted indicator
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getScreening
```
public CallingPartyNumber.Screening getScreening()
                                          throws DecodeException
```
    Gets the value of the screening indicator.
    
    Returns:
    Screening representation of the screening 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 CallingPartyNumber setNature(CallingPartyNumber.Nature value)
                             throws IllegalStateException
```
    Sets the value of the nature of address.
    
    Parameters:
    value - Nature representation of the nature of address
    
    Returns:
    this
    
    Throws:
    
    IllegalStateException
  - setNumberIncomplete
```
public CallingPartyNumber setNumberIncomplete(boolean value)
                                       throws IllegalStateException
```
    Sets the value of the number incomplete indicator.
    
    Parameters:
    value - boolean representation of the number incomplete indicator
    
    Returns:
    this
    
    Throws:
    
    IllegalStateException
  - setNumberingPlan
```
public CallingPartyNumber setNumberingPlan(CallingPartyNumber.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
  - setPresentation
```
public CallingPartyNumber setPresentation(CallingPartyNumber.Presentation value)
                                   throws IllegalStateException
```
    Sets the value of the address presentation restricted indicator.
    
    Parameters:
    value - Presentation representation of the address presentation restricted indicator
    
    Returns:
    this
    
    Throws:
    
    IllegalStateException
  - setScreening
```
public CallingPartyNumber setScreening(CallingPartyNumber.Screening value)
                                throws IllegalStateException
```
    Sets the value of the screening indicator.
    
    Parameters:
    value - Screening representation of the screening indicator
    
    Returns:
    this
    
    Throws:
    
    IllegalStateException
  - setAddress
```
public CallingPartyNumber 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<CallingPartyNumber> 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 CallingPartyNumber setAddress(String value,
                            StringCodec<CallingPartyNumber> 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 CallingPartyNumber 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 CallingPartyNumber copyOf(CallingPartyNumber 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:
    CallingPartyNumber
  - clone
```
public CallingPartyNumber 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<CallingPartyNumber> 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 Nature is not in range [0,127], or Presentation is ADDRESS_NOT_AVAILABLE and any of Address is not empty or Nature is not 0 or NumberIncomplete is true or NumberingPlan is not 0 or Screening is not NETWORK_PROVIDED
  - 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

Class CallingPartyNumber

Nested Class Summary

Field Summary

Fields inherited from class AbstractLazyEncodedDataObject

Fields inherited from class AbstractEncodedDataObject

Fields inherited from class com.opencloud.util.AbstractFieldsObject

Constructor Summary

Method Summary

Methods inherited from class AbstractLazyEncodedDataObject

Methods inherited from class com.opencloud.util.AbstractFieldsObject

Methods inherited from class com.opencloud.util.AbstractDataObject

Methods inherited from class java.lang.Object

Field Detail

ADDRESS_CODEC

Nature_value

NumberIncomplete_value

NumberIncomplete_present

NumberingPlan_value

Presentation_value

Screening_value

Address_value

Constructor Detail

CallingPartyNumber

CallingPartyNumber

CallingPartyNumber

CallingPartyNumber

CallingPartyNumber

CallingPartyNumber

Method Detail

toStream

hasNature

hasNumberIncomplete

setNumberIncompletePresent

hasNumberingPlan

hasPresentation

hasScreening

hasAddress

checkFieldsSet

getNature

getNumberIncomplete

getNumberingPlan

getPresentation

getScreening

getAddress

setNature

setNumberIncomplete

setNumberingPlan

setPresentation

setScreening

setAddress

getAddress

getAddressEncoded

setAddress

setAddressEncoded

copyOf

clone

getFieldAccessors

getFieldsMap

encodedIsInvalid

getEncodedForm

getContainedLength

getAddressCodec

encode

decode