public final class CallingPartyRestriction extends AbstractLazyEncodedByteArray implements FastSerializable
The API offered by this class is as if the type were specified in ASN.1 as follows.
CallingPartyRestriction ::= SEQUENCE { callingPartyRestrictionValue CallingPartyRestrictionValue }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 comment in ASN.1 module CAP-datatypes | ||||||||
---|---|---|---|---|---|---|---|---|
8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
Octet 1 | Spare | Calling party restriction value |
Modifier and Type | Class and Description |
---|---|
static class |
CallingPartyRestriction.CallingPartyRestrictionValue
Calling Party Restriction constants.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
CallingPartyRestriction()
Constructs a new CallingPartyRestriction object with no fields set.
|
CallingPartyRestriction(byte[] data)
Constructs a new CallingPartyRestriction object from network-encoded data.
|
CallingPartyRestriction(byte[] data,
int start,
int len)
Constructs a new CallingPartyRestriction object from part of network-encoded data.
|
CallingPartyRestriction(CallingPartyRestriction.CallingPartyRestrictionValue callingPartyRestrictionValue)
Constructs a new CallingPartyRestriction object from given values for all fields.
|
CallingPartyRestriction(DataInput in)
Constructs a new CallingPartyRestriction object from data deserialized from a stream that was written by
toStream(DataOutput) . |
Modifier and Type | Method and Description |
---|---|
void |
checkFieldsSet()
Checks that all mandatory fields are present.
|
CallingPartyRestriction |
clone()
Constructs a copy of this object and everything reachable from it.
|
static CallingPartyRestriction |
copyOf(CallingPartyRestriction 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.
|
CallingPartyRestriction.CallingPartyRestrictionValue |
getCallingPartyRestrictionValue()
Gets the value of the calling party restriction value.
|
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.
|
boolean |
hasCallingPartyRestrictionValue()
Tests whether the field CallingPartyRestrictionValue has a value.
|
CallingPartyRestriction |
setCallingPartyRestrictionValue(CallingPartyRestriction.CallingPartyRestrictionValue value)
Sets the value of the calling party restriction value.
|
void |
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by
CallingPartyRestriction(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public CallingPartyRestriction()
public CallingPartyRestriction(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic CallingPartyRestriction(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 CallingPartyRestriction(CallingPartyRestriction.CallingPartyRestrictionValue callingPartyRestrictionValue)
callingPartyRestrictionValue
- the calling party restriction valuepublic CallingPartyRestriction(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
CallingPartyRestriction(DataInput)
.toStream
in interface FastSerializable
out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasCallingPartyRestrictionValue() 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 CallingPartyRestriction.CallingPartyRestrictionValue getCallingPartyRestrictionValue() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic CallingPartyRestriction setCallingPartyRestrictionValue(CallingPartyRestriction.CallingPartyRestrictionValue value) throws IllegalStateException
value
- CallingPartyRestrictionValue representation of the calling party restriction valueIllegalStateException
public static CallingPartyRestriction copyOf(CallingPartyRestriction from)
from
- the object from which to copypublic CallingPartyRestriction 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 a fixed length, so that 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 consideredprotected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if encoding failsprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if not 1 octet to be decoded or value is out of range [1,2]