iaik.asn1
Class BMPString

java.lang.Object
  |
  +--iaik.asn1.ASN1Object
        |
        +--iaik.asn1.BMPString

public class BMPString

extends ASN1Object

This class implements the native ASN.1 type "BMPString". BMPString is a simple ASN.1 string type identified by the UNIVERSAL TAG number 30.

BMPString is a subtype of the UniversalString type and models the Basic Multilingual Plane of ISO/IEC/ITU 10646-1, a two-octet (USC-2) encoding form, which is identical to Unicode 1.1.

When creating a new BMPString object the value to be represented has to be supplied as Java String type:

 String s = ...;
 BMPString bmpString = new BMPString(s);
 

Attention: When supplying the string value to be represented, no check is performed if it actually is composed only of characters belonging to BMPString character set! An application itself has to take care for supplying a proper BMPString value.

When calling the getValue method for getting the inherent string value from an ASN.1 BMPString instance, a Java object of type String is returned:

 String s = (String)BMPString.getValue();
 

DER en/decoding generally is done by means of the several methods of the DerCoder class; decoding alternatively may be performed by using the DerInputStream utility.

See Also:

ASN1Object, ASN

Fields inherited from class iaik.asn1.ASN1Object

asnType, encode_listener, stream_mode

Constructor Summary

protected	BMPString() Creates an empty BMPString.
	BMPString(java.lang.String value) Creates a new ASN.1 BMPString object for the given String value.

Method Summary

protected void	decode(int length, java.io.InputStream is) Decodes an BMPString value from the given InputStream.
protected void	encode(java.io.OutputStream os) DER encodes this BMPString ASN1Object and writes the result to the given output stream.
java.lang.Object	getValue() Returns the value of this BMPString as a String object.
void	setValue(java.lang.Object object) Sets the value of this BMPString.
java.lang.String	toString() Returns a string that represents the contents of this BMPString.

Methods inherited from class iaik.asn1.ASN1Object

addComponent, addEncodeListener, countComponents, encodeObject, getAsnType, getComponentAt, indefiniteLength, isA, isConstructed, setIndefiniteLength, setIndefiniteRecursive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BMPString

protected BMPString()

Creates an empty BMPString.

BMPString

public BMPString(java.lang.String value)

Creates a new ASN.1 BMPString object for the given String value.

Attention: No check is performed if the supplied String value actually is composed only of characters belonging to the BMPString character set! An application itself has to take care for supplying a proper BMPString value.

Parameters:

value - the String value this BMPString object should be initialized with

Method Detail

getValue

public java.lang.Object getValue()

Returns the value of this BMPString as a String object.

Overrides:

getValue in class ASN1Object

Returns:

the value of this BMPString as a String object

setValue

public void setValue(java.lang.Object object)

Sets the value of this BMPString.

The supplied value has to be a Java object of type String. Attention: No check is performed if the supplied String value actually is composed only of characters belonging to BMPString character set! An application itself has to take care for supplying a proper BMPString value.

Overrides:

setValue in class ASN1Object

Parameters:

object - the Java String value to be set for this BMPString

encode

protected void encode(java.io.OutputStream os)
               throws java.io.IOException

DER encodes this BMPString ASN1Object and writes the result to the given output stream.

This is a protected method and will not be used by an application for DER encoding an BMPString object. An application will call one of the encode methods of the DerCoder class for performing the encoding, and the DerCoder internally will call this encode method.

Overrides:

encode in class ASN1Object

Parameters:

os - the output stream to which to write the data

Throws:

java.io.IOException - if an I/O error occurs while writing to the stream

decode

protected void decode(int length,
                      java.io.InputStream is)
               throws java.io.IOException

Decodes an BMPString value from the given InputStream. The given input stream carries DER encoded data, and the next length bytes to be read represent the value of an ASN.1 object of type BMPString.

This is a protected method and will not be used by an application for decoding a DER encoded BMPString. An application will call one of the decode methods of the DerCoder class for performing the decoding. The DerCoder then determines the number of bytes (length) occupied by the value of this BMPString object and internally calls this decode method for actually reading the value. No check is performed if the received value actually is composed only of characters belonging to the BMPString character set!

Overrides:

decode in class ASN1Object

Parameters:

length - the already decoded length, i.e. number of the bytes representing the value of the BMPString to be decoded

is - the input stream from which the DER encoded data is read in

Throws:

java.io.IOException - if there is a problem with the InputStream

toString

public java.lang.String toString()

Returns a string that represents the contents of this BMPString.

Overrides:

toString in class ASN1Object

Returns:

the string representation

See Also:

ASN1Object.toString()