public class LocationNumber extends AbstractLazyEncodedByteArray implements FastSerializable
The API offered by this class is as if the type were specified in ASN.1 as follows.
LocationNumber ::= SEQUENCE { nature Nature, routingToInternalNetworkNumber RoutingToInternalNetworkNumber, 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.30 p39 | ||||||||
---|---|---|---|---|---|---|---|---|
8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
Octet 1 | Odd? | Nature of address | ||||||
Octet 2 | Routing to internal network number | 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 |
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 |
Modifier and Type | Class and Description |
---|---|
static class |
LocationNumber.Nature
Nature of address indicator constants.
|
static class |
LocationNumber.NumberingPlan
Enumeration of Numbering Plan indicator constants.
|
static class |
LocationNumber.Presentation
Enumeration of Address Presentation Restricted indicator constants.
|
static class |
LocationNumber.RoutingToInternalNetworkNumber
Enumeration of Routing To Internal Network Number constants.
|
static class |
LocationNumber.Screening
Enumeration of Screening indicator constants.
|
Modifier and Type | Field and Description |
---|---|
static BCDStringCodec<LocationNumber> |
ADDRESS_CODEC
BCD string codec for field Address.
|
protected EncodedStringWithIndicators |
Address_value
Encoded form of field Address.
|
protected LocationNumber.Nature |
Nature_value
Value of field Nature.
|
protected LocationNumber.NumberingPlan |
NumberingPlan_value
Value of field NumberingPlan.
|
protected LocationNumber.Presentation |
Presentation_value
Value of field Presentation.
|
protected LocationNumber.RoutingToInternalNetworkNumber |
RoutingToInternalNetworkNumber_value
Value of field RoutingToInternalNetworkNumber.
|
protected LocationNumber.Screening |
Screening_value
Value of field Screening.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
LocationNumber()
Constructs a new LocationNumber object with no fields set.
|
LocationNumber(byte[] data)
Constructs a new LocationNumber object from network-encoded data.
|
LocationNumber(byte[] data,
int start,
int len)
Constructs a new LocationNumber object from part of network-encoded data.
|
LocationNumber(DataInput in)
Constructs a new LocationNumber object from data deserialized from a stream that was written by
toStream(DataOutput) . |
LocationNumber(LocationNumber.Nature nature,
LocationNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber,
LocationNumber.NumberingPlan numberingPlan,
LocationNumber.Presentation presentation,
LocationNumber.Screening screening,
String address)
Constructs a new LocationNumber object from given values for all fields.
|
LocationNumber(LocationNumber.Nature nature,
LocationNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber,
LocationNumber.NumberingPlan numberingPlan,
LocationNumber.Presentation presentation,
LocationNumber.Screening screening,
String address,
StringCodec<LocationNumber> Address_codec)
Constructs a new LocationNumber object from given arguments,
using the given codecs for encoding fields of type String.
|
Modifier and Type | Method and Description |
---|---|
void |
checkFieldsSet()
Checks that all mandatory fields are present.
|
LocationNumber |
clone()
Constructs a copy of this object and everything reachable from it.
|
static LocationNumber |
copyOf(LocationNumber 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 tmp 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<LocationNumber> codec)
Gets the value of the number digits using the given codec.
|
StringCodec<LocationNumber> |
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.
|
LocationNumber.Nature |
getNature()
Gets the value of the nature of address indicator.
|
LocationNumber.NumberingPlan |
getNumberingPlan()
Gets the value of the numbering plan indicator.
|
LocationNumber.Presentation |
getPresentation()
Gets the value of the address presentation restricted indicator.
|
LocationNumber.RoutingToInternalNetworkNumber |
getRoutingToInternalNetworkNumber()
Gets the value of the internal network number indicator.
|
LocationNumber.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 |
hasNumberingPlan()
Tests whether the field NumberingPlan has a value.
|
boolean |
hasPresentation()
Tests whether the field Presentation has a value.
|
boolean |
hasRoutingToInternalNetworkNumber()
Tests whether the field RoutingToInternalNetworkNumber has a value.
|
boolean |
hasScreening()
Tests whether the field Screening has a value.
|
LocationNumber |
setAddress(String value)
Sets the value of the number digits.
|
LocationNumber |
setAddress(String value,
StringCodec<LocationNumber> codec)
Sets the value of the number digits using the given codec.
|
LocationNumber |
setAddressEncoded(EncodedStringWithIndicators encoded)
Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.
|
LocationNumber |
setNature(LocationNumber.Nature value)
Sets the value of the nature of address indicator.
|
LocationNumber |
setNumberingPlan(LocationNumber.NumberingPlan value)
Sets the value of the numbering plan indicator.
|
LocationNumber |
setPresentation(LocationNumber.Presentation value)
Sets the value of the address presentation restricted indicator.
|
LocationNumber |
setRoutingToInternalNetworkNumber(LocationNumber.RoutingToInternalNetworkNumber value)
Sets the value of the internal network number indicator.
|
LocationNumber |
setScreening(LocationNumber.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
LocationNumber(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public static final BCDStringCodec<LocationNumber> ADDRESS_CODEC
protected LocationNumber.Nature Nature_value
protected LocationNumber.RoutingToInternalNetworkNumber RoutingToInternalNetworkNumber_value
protected LocationNumber.NumberingPlan NumberingPlan_value
protected LocationNumber.Presentation Presentation_value
protected LocationNumber.Screening Screening_value
protected EncodedStringWithIndicators Address_value
public LocationNumber()
public LocationNumber(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic LocationNumber(byte[] data, int start, int len)
start
and is len
bytes long.
The data is not decoded and might not be decodable.data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictableNullPointerException
- if data is nullIllegalArgumentException
- if len is negativepublic LocationNumber(LocationNumber.Nature nature, LocationNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber, LocationNumber.NumberingPlan numberingPlan, LocationNumber.Presentation presentation, LocationNumber.Screening screening, String address)
nature
- the nature of address indicatorroutingToInternalNetworkNumber
- the internal network number indicatornumberingPlan
- the numbering plan indicatorpresentation
- the address presentation restricted indicatorscreening
- the screening indicatoraddress
- the number digitspublic LocationNumber(LocationNumber.Nature nature, LocationNumber.RoutingToInternalNetworkNumber routingToInternalNetworkNumber, LocationNumber.NumberingPlan numberingPlan, LocationNumber.Presentation presentation, LocationNumber.Screening screening, String address, StringCodec<LocationNumber> Address_codec)
nature
- the nature of address indicatorroutingToInternalNetworkNumber
- the internal network number indicatornumberingPlan
- the numbering plan indicatorpresentation
- the address presentation restricted indicatorscreening
- the screening indicatoraddress
- the number digitsAddress_codec
- StringCodec for addresspublic LocationNumber(DataInput in) throws IOException
toStream(DataOutput)
.in
- the stream to read fromEOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be readpublic void toStream(DataOutput out) throws IOException
LocationNumber(DataInput)
.toStream
in interface FastSerializable
out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasNature() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasRoutingToInternalNetworkNumber() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasNumberingPlan() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasPresentation() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasScreening() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasAddress() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic void checkFieldsSet() throws EncodeException
checkFieldsSet
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if any mandatory field is not presentpublic LocationNumber.Nature getNature() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic LocationNumber.RoutingToInternalNetworkNumber getRoutingToInternalNetworkNumber() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic LocationNumber.NumberingPlan getNumberingPlan() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic LocationNumber.Presentation getPresentation() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic LocationNumber.Screening getScreening() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic String getAddress() throws DecodeException
getAddress(null)
.DecodeException
- if encoded state cannot be decodedpublic LocationNumber setNature(LocationNumber.Nature value) throws IllegalStateException
value
- Nature representation of the nature of address indicatorIllegalStateException
public LocationNumber setRoutingToInternalNetworkNumber(LocationNumber.RoutingToInternalNetworkNumber value) throws IllegalStateException
value
- RoutingToInternalNetworkNumber representation of the internal network number indicatorIllegalStateException
public LocationNumber setNumberingPlan(LocationNumber.NumberingPlan value) throws IllegalStateException
value
- NumberingPlan representation of the numbering plan indicatorIllegalStateException
public LocationNumber setPresentation(LocationNumber.Presentation value) throws IllegalStateException
value
- Presentation representation of the address presentation restricted indicatorIllegalStateException
public LocationNumber setScreening(LocationNumber.Screening value) throws IllegalStateException
value
- Screening representation of the screening indicatorIllegalStateException
public LocationNumber setAddress(String value) throws IllegalStateException
value
- String representation of the number digitsIllegalStateException
public String getAddress(StringCodec<LocationNumber> codec) throws DecodeException
codec
- StringCodec to use for decodingDecodeException
- if encoded state cannot be decodedpublic EncodedStringWithIndicators getAddressEncoded()
public LocationNumber setAddress(String value, StringCodec<LocationNumber> codec) throws IllegalArgumentException
value
- String representation of the number digitscodec
- StringCodec to use for encodingIllegalArgumentException
public LocationNumber setAddressEncoded(EncodedStringWithIndicators encoded)
encoded
- EncodedStringWithIndicators representation of the number digitspublic static LocationNumber copyOf(LocationNumber from)
from
- the object from which to copypublic LocationNumber clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public static FieldAccessor[] getFieldAccessors()
public Map<String,Object> getFieldsMap(boolean withAbsents)
getFieldsMap
in class AbstractFieldsObject
withAbsents
- whether to put absent optional fields into Mapprotected boolean encodedIsInvalid()
public byte[] getEncodedForm() throws EncodeException
EncodeException
- if encoding failspublic static int getContainedLength(byte[] data, int start, int len)
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.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredpublic StringCodec<LocationNumber> getAddressCodec()
protected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
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 RoutingToInternalNetworkNumber is NOT_ALLOWED or NumberingPlan is not 0 or Screening is not NETWORK_PROVIDEDprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if less than 2 octets to be decoded