iaik.asn1
Class VisibleString

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

public class VisibleString

extends ASN1Object

This class implements the native ASN.1 type "VisibleString" (ISO646String). VisibleString is a simple ASN.1 string type identified by the UNIVERSAL TAG number 26.

The ASN.1 character string type VisibleString encompasses all visible characters of the IA5 (International Alphabet 5) character set.

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

 String s = ...;
 VisibleString visibleString = new VisibleString(s);
 

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

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

 String s = (String)visibleString.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	VisibleString() Creates an empty VisibleString.
	VisibleString(java.lang.String value) Creates a new ASN.1 VisibleString object for the given String value.

Method Summary

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

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

VisibleString

protected VisibleString()

Creates an empty VisibleString.

VisibleString

public VisibleString(java.lang.String value)

Creates a new ASN.1 VisibleString 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 VisibleString character set! An application itself has to take care for supplying a proper VisibleString value.

Parameters:

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

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

Method Detail

getValue

public java.lang.Object getValue()

Returns the value of this VisibleString as a String.

Overrides:

getValue in class ASN1Object

Returns:

the value of this VisibleString as a String object

setValue

public void setValue(java.lang.Object object)

Sets the value of this VisibleString.

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 VisibleString character set! An application itself has to take care for supplying a proper VisibleString value.

Overrides:

setValue in class ASN1Object

Parameters:

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

encode

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

DER encodes this VisibleString 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 a VisibleString 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 a VisibleString 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 VisibleString.

This is a protected method and will not be used by an application for decoding a DER encoded VisibleString. 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 VisibleString 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 VisibleString character set!

Overrides:

decode in class ASN1Object

Parameters:

length - the already decoded length, i.e. number of the bytes representing the value of the VisibleString 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 VisibleString.

Overrides:

toString in class ASN1Object

Returns:

the string representation

See Also:

ASN1Object.toString()