Class CallingPartysCategory
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.CallingPartysCategory
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class CallingPartysCategory extends AbstractLazyEncodedByteArray implements FastSerializable
Class CallingPartysCategory distinguishes various operators, subscribers and payphones. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.CallingPartysCategory.The API offered by this class is as if the type were specified in ASN.1 as follows.
CallingPartysCategory ::= SEQUENCE { category Category }
The class takes care of encoding the field value into a byte-array and decoding the field value from a byte-array, the encoded representation being as tabulated below.Data Encoding - based on ITU-T Q.763 (12/1999) §3.11 p25 8 7 6 5 4 3 2 1 Octet 0 Calling party's category - See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CallingPartysCategory.Category
Calling party's category constants.
-
Field Summary
-
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 CallingPartysCategory()
Constructs a new CallingPartysCategory object with no fields set.CallingPartysCategory(byte[] data)
Constructs a new CallingPartysCategory object from network-encoded data.CallingPartysCategory(byte[] data, int start, int len)
Constructs a new CallingPartysCategory object from part of network-encoded data.CallingPartysCategory(CallingPartysCategory.Category category)
Constructs a new CallingPartysCategory object from given values for all fields.CallingPartysCategory(DataInput in)
Constructs a new CallingPartysCategory 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.CallingPartysCategory
clone()
Constructs a copy of this object and everything reachable from it.static CallingPartysCategory
copyOf(CallingPartysCategory 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.CallingPartysCategory.Category
getCategory()
Gets the value of the calling party's category value.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.boolean
hasCategory()
Tests whether the field Category has a value.CallingPartysCategory
setCategory(CallingPartysCategory.Category value)
Sets the value of the calling party's category value.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byCallingPartysCategory(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
-
-
-
-
Constructor Detail
-
CallingPartysCategory
public CallingPartysCategory()
Constructs a new CallingPartysCategory object with no fields set.
-
CallingPartysCategory
public CallingPartysCategory(byte[] data)
Constructs a new CallingPartysCategory 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
-
CallingPartysCategory
public CallingPartysCategory(byte[] data, int start, int len)
Constructs a new CallingPartysCategory 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
-
CallingPartysCategory
public CallingPartysCategory(CallingPartysCategory.Category category)
Constructs a new CallingPartysCategory object from given values for all fields.- Parameters:
category
- the calling party's category value
-
CallingPartysCategory
public CallingPartysCategory(DataInput in) throws IOException
Constructs a new CallingPartysCategory 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 byCallingPartysCategory(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
hasCategory
public boolean hasCategory() throws DecodeException
Tests whether the field Category 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
-
getCategory
public CallingPartysCategory.Category getCategory() throws DecodeException
Gets the value of the calling party's category value.- Returns:
- Category representation of the calling party's category value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setCategory
public CallingPartysCategory setCategory(CallingPartysCategory.Category value) throws IllegalStateException
Sets the value of the calling party's category value.- Parameters:
value
- Category representation of the calling party's category value- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static CallingPartysCategory copyOf(CallingPartysCategory 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:
- CallingPartysCategory
-
clone
public CallingPartysCategory 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 a fixed length, so that 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:
- 1, or 0 if encoded value is not long enough
-
encode
protected void encode() throws EncodeException
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if Category is not in range [0,255]
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if not 1 octet to be decoded
-
-