com.objsys.asn1j.runtime
Class Asn1UniversalString

java.lang.Object
  com.objsys.asn1j.runtime.Asn1Type
      com.objsys.asn1j.runtime.Asn1UniversalString

All Implemented Interfaces:

Asn1TypeIF, java.lang.Cloneable, java.io.Serializable

public class Asn1UniversalString

extends Asn1Type

This is a container class for holding the components of an ASN.1 Universal string value.

See Also:

Serialized Form

Field Summary

static int	BITSPERCHAR The BITSPERCHAR constant specifies the number of bits per character for PER (aligned or unaligned).
protected java.lang.StringBuffer	mStringBuffer
static Asn1Tag	TAG The TAG constant describes the universal tag for this data type (UNIVERSAL 28).
int[]	value The value public member variable is used to hold the string value to be encoded or the results of a decode operation.

Fields inherited from class com.objsys.asn1j.runtime.Asn1Type

BIT_STRING, BMPString, BOOLEAN, ENUMERATED, EOC, EXTERNAL, GeneralString, GeneralTime, GraphicString, IA5String, INTEGER, NULL, NumericString, OBJECT_IDENTIFIER, ObjectDescriptor, OCTET_STRING, OpenType, PrintableString, REAL, RelativeOID, SEQUENCE, SET, T61String, TeletexString, UniversalString, UTCTime, UTF8String, VideotexString, VisibleString

Constructor Summary

Asn1UniversalString()
This constructor creates an empty string that can be used in a decode method call to receive a string value.

Asn1UniversalString(int[] data)
This constructor initializes the character string from the given universal string data.

Asn1UniversalString(java.lang.String data)
This constructor converts a standard Java string value into a universal string.

Method Summary

void	decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength) This method decodes an ASN.1 universal string value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	decode(Asn1PerDecodeBuffer buffer) This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	decode(Asn1PerDecodeBuffer buffer, Asn1CharSet charSet) This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	decode(Asn1PerDecodeBuffer buffer, Asn1CharSet charSet, long lower, long upper) This overloaded version of the decode method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	decode(Asn1PerDecodeBuffer buffer, int abpc, int ubpc, Asn1CharSet charSet) This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	decode(Asn1PerDecodeBuffer buffer, int abpc, int ubpc, Asn1CharSet charSet, long lower, long upper) This overloaded version of the decode method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	decode(Asn1PerDecodeBuffer buffer, int nchars, int abpc, int ubpc, Asn1CharSet charSet, int startIdx) This method decodes the contents of a UniversalString.
void	decodeXER(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 Universal String value using the XML encoding rules (XER).
void	decodeXML(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 Universal String value using the XML schema encoding rules.
int	encode(Asn1BerEncodeBuffer buffer, boolean explicit) This method encodes an ASN.1 universal string type.
void	encode(Asn1BerOutputStream out, boolean explicit) This method encodes and writes to the stream an ASN.1 universal string including the UNIVERSAL tag value and length if explicit tagging is specified.
void	encode(Asn1PerEncodeBuffer buffer) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerEncodeBuffer buffer, Asn1CharSet charSet) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerEncodeBuffer buffer, Asn1CharSet charSet, long lower, long upper) This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerEncodeBuffer buffer, int abpc, int ubpc, Asn1CharSet charSet) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerEncodeBuffer buffer, int abpc, int ubpc, Asn1CharSet charSet, long lower, long upper) This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerEncodeBuffer buffer, int nchars, int offset, int abpc, int ubpc, Asn1CharSet charSet) This method encodes the contents of a UniversalString type.
void	encode(Asn1PerOutputStream out) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerOutputStream out, Asn1CharSet charSet) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerOutputStream out, Asn1CharSet charSet, long lower, long upper) This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerOutputStream out, int abpc, int ubpc, Asn1CharSet charSet) This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerOutputStream out, int abpc, int ubpc, Asn1CharSet charSet, long lower, long upper) This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER).
protected void	encode(Asn1PerOutputStream out, int nchars, int offset, int abpc, int ubpc, Asn1CharSet charSet) This method encodes the contents of a UniversalString type.
void	encode(Asn1XerEncoder buffer, java.lang.String elemName) This method encodes an ASN.1 Universal String value using the XML encoding rules (XER).
void	encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix) This method encodes an ASN.1 Universal String value with element & attribute name tag using the XML Encoding as specified in the XML schema standard(asn2xsd).
void	encodeData(Asn1XmlXerEncoder buffer) This method encodes an ASN.1 Universal String value using the XML Encoding as specified in the XML schema standard(asn2xsd).
boolean	equals(java.lang.Object cs_) This method compares this character string value to the given value for equality.
int	getLength() This method will return the length of the character string in characters.
java.lang.String	toString() This method will return a string representation of the value.

Methods inherited from class com.objsys.asn1j.runtime.Asn1Type

clone, decode, decode, decode, encode, encode, encode, encodeAttribute, getTypeName, indent, isOpenType, matchTag, matchTag, pdiag, print, setKey, setOpenType

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BITSPERCHAR

public static final int BITSPERCHAR

The BITSPERCHAR constant specifies the number of bits per character for PER (aligned or unaligned).

See Also:

Constant Field Values

TAG

public static final Asn1Tag TAG

The TAG constant describes the universal tag for this data type (UNIVERSAL 28).

value

public transient int[] value

The value public member variable is used to hold the string value to be encoded or the results of a decode operation. For UniversalString, the characters are stored in an array of 32-bit integer values.

mStringBuffer

protected transient java.lang.StringBuffer mStringBuffer

Constructor Detail

Asn1UniversalString

public Asn1UniversalString()

This constructor creates an empty string that can be used in a decode method call to receive a string value.

Asn1UniversalString

public Asn1UniversalString(int[] data)

This constructor initializes the character string from the given universal string data.

Parameters:

data - Character string

Asn1UniversalString

public Asn1UniversalString(java.lang.String data)

This constructor converts a standard Java string value into a universal string.

Parameters:

data - Character string

Method Detail

decode

public void decode(Asn1BerDecodeBuffer buffer,
                   boolean explicit,
                   int implicitLength)
            throws Asn1Exception,
                   java.io.IOException

This method decodes an ASN.1 universal string value including the UNIVERSAL tag value and length if explicit tagging is specified.

Specified by:

decode in interface Asn1TypeIF

Overrides:

decode in class Asn1Type

Parameters:

buffer - Decode message buffer object

explicit - Flag indicating element is explicitly tagged

implicitLength - Length of contents if implicit

Returns:

Decoded integer value

Throws:

Asn1Exception

java.io.IOException

encode

public int encode(Asn1BerEncodeBuffer buffer,
                  boolean explicit)
           throws Asn1Exception

This method encodes an ASN.1 universal string type. The UNIVERSAL tag value and length is also encoded if explicit tagging is specified.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

explicit - Flag indicating explicit tagging should be done

Returns:

Length in octets of encoded component

Throws:

Asn1Exception

decode

public void decode(Asn1PerDecodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException

This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public value member variable.

Specified by:

decode in interface Asn1TypeIF

Overrides:

decode in class Asn1Type

Parameters:

buffer - Decode message buffer object

Throws:

Asn1Exception

java.io.IOException

decode

public void decode(Asn1PerDecodeBuffer buffer,
                   Asn1CharSet charSet)
            throws Asn1Exception,
                   java.io.IOException

This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but allows a permitted alphabet character set to be specified. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public value member variable.

Parameters:

buffer - Decode message buffer object

charSet - Object representing permitted alphabet constraint character set (optional)

Throws:

Asn1Exception

java.io.IOException

decode

public void decode(Asn1PerDecodeBuffer buffer,
                   Asn1CharSet charSet,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException

This overloaded version of the decode method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present but no permitted alphabet constraint. The decoded result is stored in the public value member variable.

Parameters:

buffer - Decode message buffer object

charSet - Object representing permitted alphabet constraint character set (optional)

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

Asn1Exception

java.io.IOException

decode

protected void decode(Asn1PerDecodeBuffer buffer,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet)
               throws Asn1Exception,
                      java.io.IOException

This method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes that a permitted alphabet constraint has been specified that would reduce the the number of bits-per-character from the default character set. It also assumes a general length determinant is present (i.e. there is not size constraint). The decoded result is stored in the public value member variable.

Parameters:

buffer - Decode message buffer object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

Throws:

Asn1Exception

java.io.IOException

decode

protected void decode(Asn1PerDecodeBuffer buffer,
                      int nchars,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet,
                      int startIdx)
               throws Asn1Exception,
                      java.io.IOException

This method decodes the contents of a UniversalString. This version of the method assumes a permitted alphabet constraint is in place.

Parameters:

buffer - Decode message buffer object

nchars - Number of characters

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

startIdx - Start index to fill in value array

Throws:

Asn1Exception

java.io.IOException

decode

protected void decode(Asn1PerDecodeBuffer buffer,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet,
                      long lower,
                      long upper)
               throws Asn1Exception,
                      java.io.IOException

This overloaded version of the decode method decodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present but no permitted alphabet constraint. The decoded result is stored in the public value member variable.

Parameters:

buffer - Decode message buffer object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing permitted alphabet constraint character set (optional)

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

Asn1Exception

java.io.IOException

encode

public void encode(Asn1PerEncodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. The value to encode is stored in the public value member variable.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

Throws:

Asn1Exception

java.io.IOException

encode

public void encode(Asn1PerEncodeBuffer buffer,
                   Asn1CharSet charSet)
            throws Asn1Exception,
                   java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but does allow a permitted alphabet character set to be specified. The value to encode is stored in the public value member variable.

Parameters:

buffer - Encode message buffer object

charSet - Object representing permitted alphabet constraint character set (optional)

Throws:

Asn1Exception

java.io.IOException

encode

public void encode(Asn1PerEncodeBuffer buffer,
                   Asn1CharSet charSet,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException

This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes both a size constraint and permitted alphabet constraint are present. The value to encode is stored in the public value member variable.

Parameters:

buffer - Encode message buffer object

charSet - Object representing the permitted alphabet constraint character set

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

Asn1Exception

java.io.IOException

encode

protected void encode(Asn1PerEncodeBuffer buffer,
                      int nchars,
                      int offset,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet)
               throws Asn1Exception

This method encodes the contents of a UniversalString type. This version assumes a permitted alphabet constraint was specified.

Parameters:

buffer - Encode message buffer object

nchars - Number of characters from string to encode

offset - Offset to first char in string to encode

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing permitted alphabet constraint character set (optional)

Throws:

Asn1Exception

encode

protected void encode(Asn1PerEncodeBuffer buffer,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet)
               throws Asn1Exception,
                      java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. The value to encode is stored in the public value member variable.

Parameters:

buffer - Encode message buffer object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

Throws:

Asn1Exception

java.io.IOException

encode

protected void encode(Asn1PerEncodeBuffer buffer,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet,
                      long lower,
                      long upper)
               throws Asn1Exception,
                      java.io.IOException

This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present but no permitted alphabet constraint. The value to encode is stored in the public value member variable.

Parameters:

buffer - Encode message buffer object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

Asn1Exception

java.io.IOException

encode

public void encode(Asn1XerEncoder buffer,
                   java.lang.String elemName)
            throws java.io.IOException,
                   Asn1Exception

This method encodes an ASN.1 Universal String value using the XML encoding rules (XER).

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

elemName - Element name

Throws:

java.io.IOException - Any exception thrown by the underlying stream.

Asn1Exception - Thrown, if operation is failed.

decodeXER

public void decodeXER(java.lang.String buffer,
                      java.lang.String attrs)
               throws Asn1Exception

This method decodes an ASN.1 Universal String value using the XML encoding rules (XER).

Parameters:

buffer - String containing data to be decoded

attrs - Attributes string from element tag

Throws:

Asn1Exception

encode

public void encode(Asn1XmlEncoder buffer,
                   java.lang.String elemName,
                   java.lang.String nsPrefix)
            throws java.io.IOException,
                   Asn1Exception

This method encodes an ASN.1 Universal String value with element & attribute name tag using the XML Encoding as specified in the XML schema standard(asn2xsd).

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

elemName - Element name

nsPrefix - Element namespace prefix value

Throws:

Asn1Exception - Thrown, if operation is failed.

java.io.IOException - Any exception thrown by the underlying stream.

encodeData

public void encodeData(Asn1XmlXerEncoder buffer)
                throws java.io.IOException,
                       Asn1Exception

This method encodes an ASN.1 Universal String value using the XML Encoding as specified in the XML schema standard(asn2xsd).

Parameters:

buffer - Encode message buffer object

Throws:

java.io.IOException

Asn1Exception

decodeXML

public void decodeXML(java.lang.String buffer,
                      java.lang.String attrs)
               throws Asn1Exception

This method decodes an ASN.1 Universal String value using the XML schema encoding rules.

Specified by:

decodeXML in interface Asn1TypeIF

Overrides:

decodeXML in class Asn1Type

Parameters:

buffer - String containing data to be decoded

attrs - Attributes string from element tag

Throws:

Asn1Exception

equals

public boolean equals(java.lang.Object cs_)

This method compares this character string value to the given value for equality.

Parameters:

cs_ - String value

getLength

public int getLength()
              throws Asn1InvalidLengthException

This method will return the length of the character string in characters.

Overrides:

getLength in class Asn1Type

Returns:

Number of characters.

Throws:

Asn1InvalidLengthException

toString

public java.lang.String toString()

This method will return a string representation of the value. The format is the ASN.1 vlaue format for this type..

Returns:

Stringified representation of the value

encode

public void encode(Asn1BerOutputStream out,
                   boolean explicit)
            throws Asn1Exception,
                   java.io.IOException

This method encodes and writes to the stream an ASN.1 universal string including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER).

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

out - BER Output Stream object

explicit - Flag indicating explicit tagging should be done

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

public void encode(Asn1PerOutputStream out)
            throws Asn1Exception,
                   java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. The value to encode is stored in the public value member variable.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

out - PER Output Stream object

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

public void encode(Asn1PerOutputStream out,
                   Asn1CharSet charSet)
            throws Asn1Exception,
                   java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but does allow a permitted alphabet character set to be specified. The value to encode is stored in the public value member variable.

Parameters:

out - PER Output Stream object

charSet - Object representing permitted alphabet constraint character set (optional)

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

public void encode(Asn1PerOutputStream out,
                   Asn1CharSet charSet,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException

This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes both a size constraint and permitted alphabet constraint are present. The value to encode is stored in the public value member variable.

Parameters:

out - PER Output Stream object

charSet - Object representing the permitted alphabet constraint character set

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

protected void encode(Asn1PerOutputStream out,
                      int nchars,
                      int offset,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet)
               throws Asn1Exception,
                      java.io.IOException

This method encodes the contents of a UniversalString type. This version assumes a permitted alphabet constraint was specified.

Parameters:

out - PER Output Stream object

nchars - Number of characters from string to encode

offset - Offset to first char in string to encode

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing permitted alphabet constraint character set (optional)

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

protected void encode(Asn1PerOutputStream out,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet)
               throws Asn1Exception,
                      java.io.IOException

This method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. The value to encode is stored in the public value member variable.

Parameters:

out - PER Output Stream object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

protected void encode(Asn1PerOutputStream out,
                      int abpc,
                      int ubpc,
                      Asn1CharSet charSet,
                      long lower,
                      long upper)
               throws Asn1Exception,
                      java.io.IOException

This overloaded version of the encode method encodes an ASN.1 UniversalString value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present but no permitted alphabet constraint. The value to encode is stored in the public value member variable.

Parameters:

out - PER Output Stream object

abpc - Number of bits per character (aligned)

ubpc - Number of bits per character (unaligned)

charSet - Object representing the permitted alphabet constraint character set (optional)

lower - Effective size constraint lower bound

upper - Effective size constraint upper bound

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.