Class RedirectingPartyNumber
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.RedirectingPartyNumber
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public class RedirectingPartyNumber extends AbstractLazyEncodedByteArray implements FastSerializable
Class RedirectingPartyNumber represents a redirecting number. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.RedirectingPartyID.The API offered by this class is as if the type were specified in ASN.1 as follows.
RedirectingPartyNumber ::= SEQUENCE { nature Nature, numberingPlan NumberingPlan, presentation Presentation, 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.44 p49 8 7 6 5 4 3 2 1 Octet 1 Odd? Nature of address Octet 2 Spare Numbering plan Address presentation restricted 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. 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 Description static class
RedirectingPartyNumber.Nature
Nature-of-address indicator constants.static class
RedirectingPartyNumber.NumberingPlan
Enumeration of Numbering Plan indicator constants.static class
RedirectingPartyNumber.Presentation
Enumeration of Address Presentation Restricted indicator constants.
-
Field Summary
Fields Modifier and Type Field Description static BCDStringCodec<RedirectingPartyNumber>
ADDRESS_CODEC
BCD string codec for field Address.protected EncodedStringWithIndicators
Address_value
Encoded form of field Address.protected RedirectingPartyNumber.Nature
Nature_value
Value of field Nature.protected RedirectingPartyNumber.NumberingPlan
NumberingPlan_value
Value of field NumberingPlan.protected RedirectingPartyNumber.Presentation
Presentation_value
Value of field Presentation.-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
isDecoded
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
encoded
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description RedirectingPartyNumber()
Constructs a new RedirectingPartyNumber object with no fields set.RedirectingPartyNumber(byte[] data)
Constructs a new RedirectingPartyNumber object from network-encoded data.RedirectingPartyNumber(byte[] data, int start, int len)
Constructs a new RedirectingPartyNumber object from part of network-encoded data.RedirectingPartyNumber(RedirectingPartyNumber.Nature nature, RedirectingPartyNumber.NumberingPlan numberingPlan, RedirectingPartyNumber.Presentation presentation, String address)
Constructs a new RedirectingPartyNumber object from given values for all fields.RedirectingPartyNumber(RedirectingPartyNumber.Nature nature, RedirectingPartyNumber.NumberingPlan numberingPlan, RedirectingPartyNumber.Presentation presentation, String address, StringCodec<RedirectingPartyNumber> Address_codec)
Constructs a new RedirectingPartyNumber object from given arguments, using the given codecs for encoding fields of type String.RedirectingPartyNumber(DataInput in)
Constructs a new RedirectingPartyNumber object from data deserialized from a stream that was written bytoStream(DataOutput)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.RedirectingPartyNumber
clone()
Constructs a copy of this object and everything reachable from it.static RedirectingPartyNumber
copyOf(RedirectingPartyNumber 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<RedirectingPartyNumber> codec)
Gets the value of the number digits using the given codec.StringCodec<RedirectingPartyNumber>
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 offsetstart
in the givendata
.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.RedirectingPartyNumber.Nature
getNature()
Gets the value of the nature of address indicator.RedirectingPartyNumber.NumberingPlan
getNumberingPlan()
Gets the value of the numbering plan indicator.RedirectingPartyNumber.Presentation
getPresentation()
Gets the value of the address presentation restricted indicator.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
hasPresentation()
Tests whether the field Presentation has a value.RedirectingPartyNumber
setAddress(String value)
Sets the value of the number digits.RedirectingPartyNumber
setAddress(String value, StringCodec<RedirectingPartyNumber> codec)
Sets the value of the number digits using the given codec.RedirectingPartyNumber
setAddressEncoded(EncodedStringWithIndicators encoded)
Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.RedirectingPartyNumber
setNature(RedirectingPartyNumber.Nature value)
Sets the value of the nature of address indicator.RedirectingPartyNumber
setNumberingPlan(RedirectingPartyNumber.NumberingPlan value)
Sets the value of the numbering plan indicator.RedirectingPartyNumber
setPresentation(RedirectingPartyNumber.Presentation value)
Sets the value of the address presentation restricted indicator.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byRedirectingPartyNumber(DataInput)
.-
Methods inherited from class com.opencloud.slee.resources.cgin.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
-
-
-
-
Field Detail
-
ADDRESS_CODEC
public static final BCDStringCodec<RedirectingPartyNumber> ADDRESS_CODEC
BCD string codec for field Address.
-
Nature_value
protected RedirectingPartyNumber.Nature Nature_value
Value of field Nature.
-
NumberingPlan_value
protected RedirectingPartyNumber.NumberingPlan NumberingPlan_value
Value of field NumberingPlan.
-
Presentation_value
protected RedirectingPartyNumber.Presentation Presentation_value
Value of field Presentation.
-
Address_value
protected EncodedStringWithIndicators Address_value
Encoded form of field Address.
-
-
Constructor Detail
-
RedirectingPartyNumber
public RedirectingPartyNumber()
Constructs a new RedirectingPartyNumber object with no fields set.
-
RedirectingPartyNumber
public RedirectingPartyNumber(byte[] data)
Constructs a new RedirectingPartyNumber 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
-
RedirectingPartyNumber
public RedirectingPartyNumber(byte[] data, int start, int len)
Constructs a new RedirectingPartyNumber object from part of network-encoded data. The part starts at indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- if len is negative
-
RedirectingPartyNumber
public RedirectingPartyNumber(RedirectingPartyNumber.Nature nature, RedirectingPartyNumber.NumberingPlan numberingPlan, RedirectingPartyNumber.Presentation presentation, String address)
Constructs a new RedirectingPartyNumber object from given values for all fields.- Parameters:
nature
- the nature of address indicatornumberingPlan
- the numbering plan indicatorpresentation
- the address presentation restricted indicatoraddress
- the number digits
-
RedirectingPartyNumber
public RedirectingPartyNumber(RedirectingPartyNumber.Nature nature, RedirectingPartyNumber.NumberingPlan numberingPlan, RedirectingPartyNumber.Presentation presentation, String address, StringCodec<RedirectingPartyNumber> Address_codec)
Constructs a new RedirectingPartyNumber object from given arguments, using the given codecs for encoding fields of type String.- Parameters:
nature
- the nature of address indicatornumberingPlan
- the numbering plan indicatorpresentation
- the address presentation restricted indicatoraddress
- the number digitsAddress_codec
- StringCodec for address
-
RedirectingPartyNumber
public RedirectingPartyNumber(DataInput in) throws IOException
Constructs a new RedirectingPartyNumber object from data deserialized from a stream that was written bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- 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 byRedirectingPartyNumber(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- 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
-
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
-
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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if any mandatory field is not present
-
getNature
public RedirectingPartyNumber.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
-
getNumberingPlan
public RedirectingPartyNumber.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 RedirectingPartyNumber.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
-
getAddress
public String getAddress() throws DecodeException
Gets the value of the number digits. Equivalent togetAddress(null)
.- Returns:
- String representation of the number digits
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setNature
public RedirectingPartyNumber setNature(RedirectingPartyNumber.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
-
setNumberingPlan
public RedirectingPartyNumber setNumberingPlan(RedirectingPartyNumber.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 RedirectingPartyNumber setPresentation(RedirectingPartyNumber.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
-
setAddress
public RedirectingPartyNumber 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<RedirectingPartyNumber> 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 RedirectingPartyNumber setAddress(String value, StringCodec<RedirectingPartyNumber> 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 digitscodec
- StringCodec to use for encoding- Returns:
- this
- Throws:
IllegalArgumentException
-
setAddressEncoded
public RedirectingPartyNumber 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 RedirectingPartyNumber copyOf(RedirectingPartyNumber 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:
- RedirectingPartyNumber
-
clone
public RedirectingPartyNumber clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- 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 classAbstractFieldsObject
- 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 offsetstart
in the givendata
. 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 datastart
- index into data where value commenceslen
- length in data to be considered- Returns:
- len, or 0 if encoded value is not long enough
-
getAddressCodec
public StringCodec<RedirectingPartyNumber> 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 classAbstractLazyEncodedDataObject<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 NumberingPlan is not 0
-
decode
protected void decode()
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if less than 2 octets to be decoded
-
-