Package com.oss.asn1
Class ContainingOctetString<T extends AbstractData>
java.lang.Object
com.oss.asn1.AbstractData
com.oss.asn1.AbstractBinary
com.oss.asn1.OctetString
com.oss.asn1.ContainingOctetString<T>
- Type Parameters:
T
- type of contained value
- All Implemented Interfaces:
com.oss.asn1.PDUContainer<T>
,com.oss.asn1.Sizeable
,Serializable
,Cloneable
public class ContainingOctetString<T extends AbstractData>
extends OctetString
implements com.oss.asn1.PDUContainer<T>
The ContainingOctetString class represents an ASN.1 OCTET STRING that is
constrained by a ContentsConstraint. The runtime presents the value of
this type in two forms: interpreted (the unencoded contained value) or
uninterpreted (raw octets).
For this reason the class could behave differently when compared with the
For this reason the class could behave differently when compared with the
OctetString
class:
- When the automatic decoding of contained values is enabled and the content
constraint allows automatic decoding, the coder constructs the decoded
value using the interpreted form. Hence,
getDecodedValue()
returns the contained value, whilebyteArrayValue()
returnsnull
, andgetSize()
returns zero. Otherwise, the value is constructed using the uninterpreted form, wherebyteArrayValue()
andgetSize()
return raw octets, andgetDecodedValue()
returnsnull
. - When the automatic encoding of contained values is enabled, the content constraint allows automatic encoding, and the input value is specified in the interpreted form, the coder automatically constructs the octets of the OCTET STRING from the contained value and writes them to the output encoding. Otherwise, the coder requires that uninterpreted form is available before encoding, and throws an exception if it is not.
- Since:
- ASN.1/Java 6.0
- See Also:
-
Field Summary
Fields inherited from class com.oss.asn1.AbstractData
EQUALS, GREATER_THAN, LESS_THAN
-
Constructor Summary
ConstructorsConstructorDescriptionThe default constructor.ContainingOctetString
(byte[] value) Construct from a byte[].ContainingOctetString
(T decodedValue) Construct an instance of this class with an AbstractData object that represents an unencoded value of a contained ASN.1 type. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone 'this' object.final boolean
equalTo
(ContainingOctetString that) Compare 'this' object to another OctetString object to see if their contents are the same.Get the unencoded value of contained ASN.1 type.final T
Get the unencoded value of contained ASN.1 type.void
setContainedValue
(T decodedValue) Set the value to the interpreted form (the value of the contained ASN.1 type).final void
setDecodedValue
(T decodedValue) Set the value to the interpreted form (the value of the contained ASN.1 type).Methods inherited from class com.oss.asn1.OctetString
equalTo, getSize, getTypeName
Methods inherited from class com.oss.asn1.AbstractBinary
byteArrayValue, delete, hashCode, setValue
Methods inherited from class com.oss.asn1.AbstractData
equals, isEncodable, isPDU, isValid, toString, toString
-
Constructor Details
-
ContainingOctetString
public ContainingOctetString()The default constructor. -
ContainingOctetString
public ContainingOctetString(byte[] value) Construct from a byte[].- Parameters:
value
- the byte[] to set 'this' object to.
-
ContainingOctetString
Construct an instance of this class with an AbstractData object that represents an unencoded value of a contained ASN.1 type.- Parameters:
decodedValue
- the AbstractData object to set.
-
-
Method Details
-
getDecodedValue
Get the unencoded value of contained ASN.1 type. This will be useful when automatic decoding has been used. See the methodenableAutomaticDecoding()
in the Coder class.- Specified by:
getDecodedValue
in interfacecom.oss.asn1.PDUContainer<T extends AbstractData>
- Returns:
- reference to the AbstractData object representing the unencoded value of 'this' object.
-
setDecodedValue
Set the value to the interpreted form (the value of the contained ASN.1 type). After this method is invoked thebyteArrayValue()
method will returnnull
and thegetSize()
method will return zero.- Specified by:
setDecodedValue
in interfacecom.oss.asn1.PDUContainer<T extends AbstractData>
- Parameters:
decodedValue
- the reference to the AbstractData object to set.
-
getContainedValue
Get the unencoded value of contained ASN.1 type. This will be useful when automatic decoding has been used. See the methodenableAutomaticDecoding()
in the Coder class.- Returns:
- reference to the AbstractData object representing the unencoded value of 'this' object.
-
setContainedValue
Set the value to the interpreted form (the value of the contained ASN.1 type). After this method is invoked thebyteArrayValue()
method will returnnull
and thegetSize()
method will return zero.- Parameters:
decodedValue
- the reference to the AbstractData object to set.
-
equalTo
Compare 'this' object to another OctetString object to see if their contents are the same.- Parameters:
that
- the OctetString object to compare 'this' object to.- Returns:
- true if contents of both objects are the same.
-
clone
Clone 'this' object.- Overrides:
clone
in classOctetString
- Returns:
- deep copy of 'this' object.
-