Package com.oss.asn1

Class ContainingOctetString<T extends AbstractData>

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 OctetString class:
  1. 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, while byteArrayValue() returns null, and getSize() returns zero. Otherwise, the value is constructed using the uninterpreted form, where byteArrayValue() and getSize() return raw octets, and getDecodedValue() returns null.
  2. 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 the uninterpreted form is available before encoding, and throws an exception if it is not.
Since:
ASN.1/Java 1.5
See Also:
  • 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

      public ContainingOctetString(T decodedValue)
      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

      public final T getDecodedValue()
      Get the unencoded value of contained ASN.1 type. This will be useful when automatic decoding has been used. See the method enableAutomaticDecoding() in the Coder class.
      Specified by:
      getDecodedValue in interface com.oss.asn1.PDUContainer<T extends AbstractData>
      Returns:
      reference to the AbstractData object representing the unencoded value of 'this' object.
    • setDecodedValue

      public final void setDecodedValue(T decodedValue)
      Set the value to the interpreted form (the value of the contained ASN.1 type). After this method is invoked the byteArrayValue() method will return null and the getSize() method will return zero.
      Specified by:
      setDecodedValue in interface com.oss.asn1.PDUContainer<T extends AbstractData>
      Parameters:
      decodedValue - the reference to the AbstractData object to set.
    • getContainedValue

      public T getContainedValue()
      Get the unencoded value of contained ASN.1 type. This will be useful when automatic decoding has been used. See the method enableAutomaticDecoding() in the Coder class.
      Returns:
      reference to the AbstractData object representing the unencoded value of 'this' object.
    • setContainedValue

      public void setContainedValue(T decodedValue)
      Set the value to the interpreted form (the value of the contained ASN.1 type). After this method is invoked the byteArrayValue() method will return null and the getSize() method will return zero.
      Parameters:
      decodedValue - the reference to the AbstractData object to set.
    • equalTo

      public final boolean equalTo(ContainingOctetString that)
      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

      public Object clone()
      Clone 'this' object.
      Overrides:
      clone in class AbstractBinary
      Returns:
      deep copy of 'this' object.