Class ISDNSubaddress
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.map.ISDNSubaddress
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class ISDNSubaddress extends AbstractLazyEncodedByteArray implements FastSerializable
Class ISDNSubaddress encapsulates an ISDN subaddress. It represents the ASN.1 OCTET STRING type MAP-CommonDataTypes.ISDN-SubaddressString.The API offered by this class is as if the type were specified in ASN.1 as follows.
ISDNSubaddress ::= CHOICE { nsap NSAPAddress, user DigitOrCharString }
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 comment in ASN.1 module MAP-CommonDataTypes in 3GPP TS 29.002 V10.0.0 (2010-09) p420 8 7 6 5 4 3 2 1 1 octet 1 (ext) Nature of address discriminates... Odd? 0 0 0 ≤20 octets case 0 (NSAP) Network Service Access Point (NSAP) address case 2 (USER_SPECIFIED) User-specified address
Field names ending in ? are booleans: 1 for true, 0 for false. The value of Nature of address is 000 for choicensap
and 010 for choiceuser
. The value of Odd? is set only for the choiceuser
and only if that's encoding uses BCD.If the user field is encoded using BCD, then each digit of the user 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 Description static class
ISDNSubaddress.Choice
Enumeration of discriminating values.
-
Field Summary
Fields Modifier and Type Field Description static BCDStringCodec<ISDNSubaddress>
USER_CODEC
BCD string codec for field User.-
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 ISDNSubaddress()
Constructs a new ISDNSubaddress object with no fields set.ISDNSubaddress(byte[] data)
Constructs a new ISDNSubaddress object from network-encoded data.ISDNSubaddress(byte[] data, int start, int len)
Constructs a new ISDNSubaddress object from part of network-encoded data.ISDNSubaddress(DataInput in)
Constructs a new ISDNSubaddress 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.ISDNSubaddress
clone()
Constructs a copy of this object and everything reachable from it.static ISDNSubaddress
copyOf(ISDNSubaddress 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.ISDNSubaddress.Choice
getChoice()
Gets the discriminant for which choice is chosen.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 :discriminant-name to field-value.NSAPAddress
getNsap()
Gets the value of the number digits.String
getUser()
Gets the value of the number digits.String
getUser(StringCodec<ISDNSubaddress> codec)
Gets the value of the number digits using the given codec.StringCodec<ISDNSubaddress>
getUserCodec()
Gets the codec used for field User.EncodedStringWithIndicators
getUserEncoded()
Gets a clone of the encoded value of the number digits.boolean
isNsapChosen()
Tests whether the choice is nsap.boolean
isUserChosen()
Tests whether the choice is user.ISDNSubaddress
setNsap(NSAPAddress value)
Sets the value of the number digits.void
setReadOnly()
Sets this and all its fields to be immutable.ISDNSubaddress
setUser(String value)
Sets the value of the number digits.ISDNSubaddress
setUser(String value, StringCodec<ISDNSubaddress> codec)
Sets the value of the number digits using the given codec.ISDNSubaddress
setUserEncoded(EncodedStringWithIndicators encoded)
Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byISDNSubaddress(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
-
-
-
-
Field Detail
-
USER_CODEC
public static final BCDStringCodec<ISDNSubaddress> USER_CODEC
BCD string codec for field User.
-
-
Constructor Detail
-
ISDNSubaddress
public ISDNSubaddress()
Constructs a new ISDNSubaddress object with no fields set.
-
ISDNSubaddress
public ISDNSubaddress(byte[] data)
Constructs a new ISDNSubaddress 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
-
ISDNSubaddress
public ISDNSubaddress(byte[] data, int start, int len)
Constructs a new ISDNSubaddress 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
-
ISDNSubaddress
public ISDNSubaddress(DataInput in) throws IOException
Constructs a new ISDNSubaddress 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 byISDNSubaddress(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
getChoice
public ISDNSubaddress.Choice getChoice() throws DecodeException
Gets the discriminant for which choice is chosen.- Returns:
- enumerated constant
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isNsapChosen
public boolean isNsapChosen() throws DecodeException
Tests whether the choice is nsap.- Returns:
- true if chosen, false if not
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isUserChosen
public boolean isUserChosen() throws DecodeException
Tests whether the choice is user.- Returns:
- true if chosen, false if not
- 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
-
getNsap
public NSAPAddress getNsap() throws DecodeException
Gets the value of the number digits.- Returns:
- NSAPAddress representation of the number digits, if choice is the number digits, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getUser
public String getUser() throws DecodeException
Gets the value of the number digits. Equivalent togetUser(null)
.- Returns:
- String representation of the number digits, if choice is the number digits, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setNsap
public ISDNSubaddress setNsap(NSAPAddress value) throws IllegalStateException
Sets the value of the number digits.- Parameters:
value
- NSAPAddress representation of the number digits- Returns:
- this
- Throws:
IllegalStateException
-
setUser
public ISDNSubaddress setUser(String value) throws IllegalStateException
Sets the value of the number digits.- Parameters:
value
- String representation of the number digits- Returns:
- this
- Throws:
IllegalStateException
-
getUser
public String getUser(StringCodec<ISDNSubaddress> codec) throws DecodeException
Gets the value of the number digits using the given codec. If the field User 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
-
getUserEncoded
public EncodedStringWithIndicators getUserEncoded()
Gets a clone of the encoded value of the number digits.- Returns:
- EncodedStringWithIndicators representation of the number digits, if choice is the number digits, else null
-
setUser
public ISDNSubaddress setUser(String value, StringCodec<ISDNSubaddress> 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
-
setUserEncoded
public ISDNSubaddress setUserEncoded(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 ISDNSubaddress copyOf(ISDNSubaddress 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:
- ISDNSubaddress
-
clone
public ISDNSubaddress 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
-
setReadOnly
public void setReadOnly()
Sets this and all its fields to be immutable.- Specified by:
setReadOnly
in interfaceDataObject
- Overrides:
setReadOnly
in classAbstractDataObject
-
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 :discriminant-name to field-value. If choice is not set, returns a Map from : to AbstractFieldsObject.FIELD_UNINITIALISED. For a field of primitive type, the field-value is boxed. 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
- the value of this parameter is ignored- Returns:
- Map from :discriminant-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
-
getUserCodec
public StringCodec<ISDNSubaddress> getUserCodec()
Gets the codec used for field User.- 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 address not set
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if less than one octet to be decoded
-
-