Class CUGInterLockCode
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.CUGInterLockCode
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class CUGInterLockCode extends AbstractLazyEncodedByteArray implements FastSerializable
Class CUGInterLockCode represents a closed user group interlock code.The API offered by this class is as if the type were specified in ASN.1 as follows.
CUGInterLockCode ::= SEQUENCE { networkId DigitString, code INTEGER }
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.15 p28 8 7 6 5 4 3 2 1 Octet 1 NetworkId digit 1 NetworkId digit 2 Octet 2 NetworkId digit 3 NetworkId digit 4 Octet 3 Binary code MSB Octet 4 Binary code LSB
The octet numbering in the above table is based on that used in the cited standard.Each digit of the NetworkId field, which should be exactly 4 digits long, is encoded into a semi-octet by a
StringCodec
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
-
-
Field Summary
Fields Modifier and Type Field Description static BCDStringCodec<CUGInterLockCode>
NETWORKID_CODEC
BCD string codec for field NetworkId.-
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 CUGInterLockCode()
Constructs a new CUGInterLockCode object with no fields set.CUGInterLockCode(byte[] data)
Constructs a new CUGInterLockCode object from network-encoded data.CUGInterLockCode(byte[] data, int start, int len)
Constructs a new CUGInterLockCode object from part of network-encoded data.CUGInterLockCode(DataInput in)
Constructs a new CUGInterLockCode object from data deserialized from a stream that was written bytoStream(DataOutput)
.CUGInterLockCode(String networkId, int code)
Constructs a new CUGInterLockCode object from given values for all fields.CUGInterLockCode(String networkId, int code, StringCodec<CUGInterLockCode> NetworkId_codec)
Constructs a new CUGInterLockCode object from given arguments, using the given codecs for encoding fields of type String.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.CUGInterLockCode
clone()
Constructs a copy of this object and everything reachable from it.static CUGInterLockCode
copyOf(CUGInterLockCode 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.int
getCode()
Gets the value of the binary code.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.String
getNetworkId()
Gets the value of the network identity.String
getNetworkId(StringCodec<CUGInterLockCode> codec)
Gets the value of the network identity using the given codec.StringCodec<CUGInterLockCode>
getNetworkIdCodec()
Gets the codec used for field NetworkId.byte[]
getNetworkIdEncoded()
Gets a clone of the encoded value of the network identity.boolean
hasCode()
Tests whether the field Code has a value.boolean
hasNetworkId()
Tests whether the field NetworkId has a value.CUGInterLockCode
setCode(int value)
Sets the value of the binary code.CUGInterLockCode
setCodePresent(boolean flag)
Sets the presence or absence of the field Code.CUGInterLockCode
setNetworkId(String value)
Sets the value of the network identity.CUGInterLockCode
setNetworkId(String value, StringCodec<CUGInterLockCode> codec)
Sets the value of the network identity using the given codec.CUGInterLockCode
setNetworkIdEncoded(byte[] encoded)
Sets the encoded value of the network identity to a clone of the given byte array.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byCUGInterLockCode(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
-
-
-
-
Field Detail
-
NETWORKID_CODEC
public static final BCDStringCodec<CUGInterLockCode> NETWORKID_CODEC
BCD string codec for field NetworkId.
-
-
Constructor Detail
-
CUGInterLockCode
public CUGInterLockCode()
Constructs a new CUGInterLockCode object with no fields set.
-
CUGInterLockCode
public CUGInterLockCode(byte[] data)
Constructs a new CUGInterLockCode 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
-
CUGInterLockCode
public CUGInterLockCode(byte[] data, int start, int len)
Constructs a new CUGInterLockCode 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
-
CUGInterLockCode
public CUGInterLockCode(String networkId, int code)
Constructs a new CUGInterLockCode object from given values for all fields.- Parameters:
networkId
- the network identitycode
- the binary code
-
CUGInterLockCode
public CUGInterLockCode(String networkId, int code, StringCodec<CUGInterLockCode> NetworkId_codec)
Constructs a new CUGInterLockCode object from given arguments, using the given codecs for encoding fields of type String.- Parameters:
networkId
- the network identitycode
- the binary codeNetworkId_codec
- StringCodec for networkId
-
CUGInterLockCode
public CUGInterLockCode(DataInput in) throws IOException
Constructs a new CUGInterLockCode 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 byCUGInterLockCode(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
hasNetworkId
public boolean hasNetworkId() throws DecodeException
Tests whether the field NetworkId has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasCode
public boolean hasCode() throws DecodeException
Tests whether the field Code has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setCodePresent
public CUGInterLockCode setCodePresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the field Code.- Parameters:
flag
- whether the field should be marked as present- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
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
-
getNetworkId
public String getNetworkId() throws DecodeException
Gets the value of the network identity. Equivalent togetNetworkId(null)
.- Returns:
- String representation of the network identity
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getCode
public int getCode() throws DecodeException
Gets the value of the binary code.- Returns:
- int representation of the binary code
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setNetworkId
public CUGInterLockCode setNetworkId(String value) throws IllegalStateException
Sets the value of the network identity.- Parameters:
value
- String representation of the network identity- Returns:
- this
- Throws:
IllegalStateException
-
setCode
public CUGInterLockCode setCode(int value) throws IllegalStateException
Sets the value of the binary code.- Parameters:
value
- int representation of the binary code- Returns:
- this
- Throws:
IllegalStateException
-
getNetworkId
public String getNetworkId(StringCodec<CUGInterLockCode> codec) throws DecodeException
Gets the value of the network identity using the given codec. If the field NetworkId 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 network identity
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getNetworkIdEncoded
public byte[] getNetworkIdEncoded()
Gets a clone of the encoded value of the network identity.- Returns:
- byte[] representation of the network identity
-
setNetworkId
public CUGInterLockCode setNetworkId(String value, StringCodec<CUGInterLockCode> codec) throws IllegalArgumentException
Sets the value of the network identity using the given codec. If the given codec is null, uses the standard codec.- Parameters:
value
- String representation of the network identitycodec
- StringCodec to use for encoding- Returns:
- this
- Throws:
IllegalArgumentException
-
setNetworkIdEncoded
public CUGInterLockCode setNetworkIdEncoded(byte[] encoded)
Sets the encoded value of the network identity to a clone of the given byte array.- Parameters:
encoded
- byte[] representation of the network identity- Returns:
- this
-
copyOf
public static CUGInterLockCode copyOf(CUGInterLockCode 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:
- CUGInterLockCode
-
clone
public CUGInterLockCode 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:
- 4, or 0 if encoded value is not long enough
-
getNetworkIdCodec
public StringCodec<CUGInterLockCode> getNetworkIdCodec()
Gets the codec used for field NetworkId.- Returns:
- StringCodec
-
encode
protected void encode()
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if not 4 octets to be decoded
-
-