Class ForwardCallIndicators
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.ForwardCallIndicators
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class ForwardCallIndicators extends AbstractLazyEncodedByteArray implements FastSerializable
Class ForwardCallIndicators represents various indicators in call forwarding. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.ForwardCallIndicators.The API offered by this class is as if the type were specified in ASN.1 as follows.
ForwardCallIndicators ::= SEQUENCE { international BOOLEAN, endToEndMethod EndToEndMethod, interworkingEncountered BOOLEAN, endToEndInfoAvailable BOOLEAN, iSDNUserPartUsedAllTheWay BOOLEAN, iSDNUserPartPreference ISDNUserPartPreference, originatingAccessISDN BOOLEAN, sCCPMethod SCCPMethod }
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.23 p32 8 7 6 5 4 3 2 1 Octet 1 ISDN user part preference ISDN user part used all the way? End-to-end info available? Interworking encountered? End-to-end method International? Octet 2 Reserved for national use Spare SCCP method Originating access ISDN?
In the above table, the octet numbering is that used in the cited standard. Field names ending in ? are booleans: 1 for true, 0 for false.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ForwardCallIndicators.EndToEndMethod
End-to-end method indicator constants.static class
ForwardCallIndicators.ISDNUserPartPreference
ISDN user part preference indicator constants.static class
ForwardCallIndicators.SCCPMethod
Enumeration of SCCP method indicator 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 ForwardCallIndicators()
Constructs a new ForwardCallIndicators object with no fields set.ForwardCallIndicators(boolean international, ForwardCallIndicators.EndToEndMethod endToEndMethod, boolean interworkingEncountered, boolean endToEndInfoAvailable, boolean iSDNUserPartUsedAllTheWay, ForwardCallIndicators.ISDNUserPartPreference iSDNUserPartPreference, boolean originatingAccessISDN, ForwardCallIndicators.SCCPMethod sCCPMethod)
Constructs a new ForwardCallIndicators object from given values for all fields.ForwardCallIndicators(byte[] data)
Constructs a new ForwardCallIndicators object from network-encoded data.ForwardCallIndicators(byte[] data, int start, int len)
Constructs a new ForwardCallIndicators object from part of network-encoded data.ForwardCallIndicators(DataInput in)
Constructs a new ForwardCallIndicators 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.ForwardCallIndicators
clone()
Constructs a copy of this object and everything reachable from it.static ForwardCallIndicators
copyOf(ForwardCallIndicators 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.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.boolean
getEndToEndInfoAvailable()
Gets the value of whether end-to-end information is available.ForwardCallIndicators.EndToEndMethod
getEndToEndMethod()
Gets the value of the end-to-end method indicator.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
getInternational()
Gets the value of the national/international call indicator.boolean
getInterworkingEncountered()
Gets the value of the interworking indicator.ForwardCallIndicators.ISDNUserPartPreference
getISDNUserPartPreference()
Gets the value of the ISDN user part preference indicator.boolean
getISDNUserPartUsedAllTheWay()
Gets the value of whether ISDN user part is used all the way.boolean
getOriginatingAccessISDN()
Gets the value of the ISDN access indicator.ForwardCallIndicators.SCCPMethod
getSCCPMethod()
Gets the value of the SCCP method indicator.boolean
hasEndToEndInfoAvailable()
Tests whether the field EndToEndInfoAvailable has a value.boolean
hasEndToEndMethod()
Tests whether the field EndToEndMethod has a value.boolean
hasInternational()
Tests whether the field International has a value.boolean
hasInterworkingEncountered()
Tests whether the field InterworkingEncountered has a value.boolean
hasISDNUserPartPreference()
Tests whether the field ISDNUserPartPreference has a value.boolean
hasISDNUserPartUsedAllTheWay()
Tests whether the field ISDNUserPartUsedAllTheWay has a value.boolean
hasOriginatingAccessISDN()
Tests whether the field OriginatingAccessISDN has a value.boolean
hasSCCPMethod()
Tests whether the field SCCPMethod has a value.ForwardCallIndicators
setEndToEndInfoAvailable(boolean value)
Sets the value of whether end-to-end information is available.ForwardCallIndicators
setEndToEndInfoAvailablePresent(boolean flag)
Sets the presence or absence of the field EndToEndInfoAvailable.ForwardCallIndicators
setEndToEndMethod(ForwardCallIndicators.EndToEndMethod value)
Sets the value of the end-to-end method indicator.ForwardCallIndicators
setInternational(boolean value)
Sets the value of the national/international call indicator.ForwardCallIndicators
setInternationalPresent(boolean flag)
Sets the presence or absence of the field International.ForwardCallIndicators
setInterworkingEncountered(boolean value)
Sets the value of the interworking indicator.ForwardCallIndicators
setInterworkingEncounteredPresent(boolean flag)
Sets the presence or absence of the field InterworkingEncountered.ForwardCallIndicators
setISDNUserPartPreference(ForwardCallIndicators.ISDNUserPartPreference value)
Sets the value of the ISDN user part preference indicator.ForwardCallIndicators
setISDNUserPartUsedAllTheWay(boolean value)
Sets the value of whether ISDN user part is used all the way.ForwardCallIndicators
setISDNUserPartUsedAllTheWayPresent(boolean flag)
Sets the presence or absence of the field ISDNUserPartUsedAllTheWay.ForwardCallIndicators
setOriginatingAccessISDN(boolean value)
Sets the value of the ISDN access indicator.ForwardCallIndicators
setOriginatingAccessISDNPresent(boolean flag)
Sets the presence or absence of the field OriginatingAccessISDN.ForwardCallIndicators
setSCCPMethod(ForwardCallIndicators.SCCPMethod value)
Sets the value of the SCCP method indicator.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byForwardCallIndicators(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
-
ForwardCallIndicators
public ForwardCallIndicators()
Constructs a new ForwardCallIndicators object with no fields set.
-
ForwardCallIndicators
public ForwardCallIndicators(byte[] data)
Constructs a new ForwardCallIndicators 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
-
ForwardCallIndicators
public ForwardCallIndicators(byte[] data, int start, int len)
Constructs a new ForwardCallIndicators 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
-
ForwardCallIndicators
public ForwardCallIndicators(boolean international, ForwardCallIndicators.EndToEndMethod endToEndMethod, boolean interworkingEncountered, boolean endToEndInfoAvailable, boolean iSDNUserPartUsedAllTheWay, ForwardCallIndicators.ISDNUserPartPreference iSDNUserPartPreference, boolean originatingAccessISDN, ForwardCallIndicators.SCCPMethod sCCPMethod)
Constructs a new ForwardCallIndicators object from given values for all fields.- Parameters:
international
- the national/international call indicatorendToEndMethod
- the end-to-end method indicatorinterworkingEncountered
- the interworking indicatorendToEndInfoAvailable
- whether end-to-end information is availableiSDNUserPartUsedAllTheWay
- whether ISDN user part is used all the wayiSDNUserPartPreference
- the ISDN user part preference indicatororiginatingAccessISDN
- the ISDN access indicatorsCCPMethod
- the SCCP method indicator
-
ForwardCallIndicators
public ForwardCallIndicators(DataInput in) throws IOException
Constructs a new ForwardCallIndicators 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 byForwardCallIndicators(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
hasInternational
public boolean hasInternational() throws DecodeException
Tests whether the field International has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setInternationalPresent
public ForwardCallIndicators setInternationalPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field International.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
hasEndToEndMethod
public boolean hasEndToEndMethod() throws DecodeException
Tests whether the field EndToEndMethod has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasInterworkingEncountered
public boolean hasInterworkingEncountered() throws DecodeException
Tests whether the field InterworkingEncountered has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setInterworkingEncounteredPresent
public ForwardCallIndicators setInterworkingEncounteredPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field InterworkingEncountered.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
hasEndToEndInfoAvailable
public boolean hasEndToEndInfoAvailable() throws DecodeException
Tests whether the field EndToEndInfoAvailable has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setEndToEndInfoAvailablePresent
public ForwardCallIndicators setEndToEndInfoAvailablePresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field EndToEndInfoAvailable.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
hasISDNUserPartUsedAllTheWay
public boolean hasISDNUserPartUsedAllTheWay() throws DecodeException
Tests whether the field ISDNUserPartUsedAllTheWay has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setISDNUserPartUsedAllTheWayPresent
public ForwardCallIndicators setISDNUserPartUsedAllTheWayPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field ISDNUserPartUsedAllTheWay.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
hasISDNUserPartPreference
public boolean hasISDNUserPartPreference() throws DecodeException
Tests whether the field ISDNUserPartPreference has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasOriginatingAccessISDN
public boolean hasOriginatingAccessISDN() throws DecodeException
Tests whether the field OriginatingAccessISDN has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setOriginatingAccessISDNPresent
public ForwardCallIndicators setOriginatingAccessISDNPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field OriginatingAccessISDN.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
hasSCCPMethod
public boolean hasSCCPMethod() throws DecodeException
Tests whether the field SCCPMethod 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
-
getInternational
public boolean getInternational() throws DecodeException
Gets the value of the national/international call indicator.- Returns:
- boolean representation of the national/international call indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getEndToEndMethod
public ForwardCallIndicators.EndToEndMethod getEndToEndMethod() throws DecodeException
Gets the value of the end-to-end method indicator.- Returns:
- EndToEndMethod representation of the end-to-end method indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getInterworkingEncountered
public boolean getInterworkingEncountered() throws DecodeException
Gets the value of the interworking indicator.- Returns:
- boolean representation of the interworking indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getEndToEndInfoAvailable
public boolean getEndToEndInfoAvailable() throws DecodeException
Gets the value of whether end-to-end information is available.- Returns:
- boolean representation of whether end-to-end information is available
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getISDNUserPartUsedAllTheWay
public boolean getISDNUserPartUsedAllTheWay() throws DecodeException
Gets the value of whether ISDN user part is used all the way.- Returns:
- boolean representation of whether ISDN user part is used all the way
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getISDNUserPartPreference
public ForwardCallIndicators.ISDNUserPartPreference getISDNUserPartPreference() throws DecodeException
Gets the value of the ISDN user part preference indicator.- Returns:
- ISDNUserPartPreference representation of the ISDN user part preference indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getOriginatingAccessISDN
public boolean getOriginatingAccessISDN() throws DecodeException
Gets the value of the ISDN access indicator.- Returns:
- boolean representation of the ISDN access indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getSCCPMethod
public ForwardCallIndicators.SCCPMethod getSCCPMethod() throws DecodeException
Gets the value of the SCCP method indicator.- Returns:
- SCCPMethod representation of the SCCP method indicator
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setInternational
public ForwardCallIndicators setInternational(boolean value) throws IllegalStateException
Sets the value of the national/international call indicator.- Parameters:
value
- boolean representation of the national/international call indicator- Returns:
- this
- Throws:
IllegalStateException
-
setEndToEndMethod
public ForwardCallIndicators setEndToEndMethod(ForwardCallIndicators.EndToEndMethod value) throws IllegalStateException
Sets the value of the end-to-end method indicator.- Parameters:
value
- EndToEndMethod representation of the end-to-end method indicator- Returns:
- this
- Throws:
IllegalStateException
-
setInterworkingEncountered
public ForwardCallIndicators setInterworkingEncountered(boolean value) throws IllegalStateException
Sets the value of the interworking indicator.- Parameters:
value
- boolean representation of the interworking indicator- Returns:
- this
- Throws:
IllegalStateException
-
setEndToEndInfoAvailable
public ForwardCallIndicators setEndToEndInfoAvailable(boolean value) throws IllegalStateException
Sets the value of whether end-to-end information is available.- Parameters:
value
- boolean representation of whether end-to-end information is available- Returns:
- this
- Throws:
IllegalStateException
-
setISDNUserPartUsedAllTheWay
public ForwardCallIndicators setISDNUserPartUsedAllTheWay(boolean value) throws IllegalStateException
Sets the value of whether ISDN user part is used all the way.- Parameters:
value
- boolean representation of whether ISDN user part is used all the way- Returns:
- this
- Throws:
IllegalStateException
-
setISDNUserPartPreference
public ForwardCallIndicators setISDNUserPartPreference(ForwardCallIndicators.ISDNUserPartPreference value) throws IllegalStateException
Sets the value of the ISDN user part preference indicator.- Parameters:
value
- ISDNUserPartPreference representation of the ISDN user part preference indicator- Returns:
- this
- Throws:
IllegalStateException
-
setOriginatingAccessISDN
public ForwardCallIndicators setOriginatingAccessISDN(boolean value) throws IllegalStateException
Sets the value of the ISDN access indicator.- Parameters:
value
- boolean representation of the ISDN access indicator- Returns:
- this
- Throws:
IllegalStateException
-
setSCCPMethod
public ForwardCallIndicators setSCCPMethod(ForwardCallIndicators.SCCPMethod value) throws IllegalStateException
Sets the value of the SCCP method indicator.- Parameters:
value
- SCCPMethod representation of the SCCP method indicator- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static ForwardCallIndicators copyOf(ForwardCallIndicators 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:
- ForwardCallIndicators
-
clone
public ForwardCallIndicators 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:
- 2, 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 EndToEndMethod is not in range [0,3] or ISDNUserPartPreference is not in range [0,3]
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if not 2 octets to be decoded
-
-