com.objsys.asn1j.runtime

Class Asn18BitCharString

java.lang.Object

com.objsys.asn1j.runtime.Asn1Type

com.objsys.asn1j.runtime.Asn1CharString

com.objsys.asn1j.runtime.Asn18BitCharString

All Implemented Interfaces:

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

Direct Known Subclasses:

Asn1AbstractTime, Asn1Date, Asn1DateTime, Asn1Duration, Asn1IA5String, Asn1NumericString, Asn1PrintableString, Asn1Time, Asn1TimeOfDay, Asn1VisibleString

public abstract class Asn18BitCharString
extends Asn1CharString

This is an abstract base class for holding the ASN.1 8-bit character string types (IA5String, VisibleString, PrintableString, etc.).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITSPERCHAR_A The BITSPERCHAR_A constant specifies the number of bits per character for PER (aligned).
static int	BITSPERCHAR_U The BITSPERCHAR_U constant specifies the number of bits per character for PER (unaligned).

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

mStringBuffer, value

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

BIT_STRING, BMPString, BOOLEAN, DATE, DATE_TIME, DURATION, ENUMERATED, EOC, EXTERNAL, GeneralString, GeneralTime, GraphicString, IA5String, INTEGER, mNonParameterizedTypeName, NULL, NumericString, OBJECT_IDENTIFIER, ObjectDescriptor, OCTET_STRING, OID_IRI, OpenType, PrintableString, REAL, RELATIVE_OID_IRI, RelativeOID, SEQUENCE, SET, T61String, TeletexString, TIME, TIME_OF_DAY, UniversalString, UTCTime, UTF8String, VideotexString, VisibleString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Asn18BitCharString(short typeCode) The default constructor creates an empty string object.
protected	Asn18BitCharString(java.lang.String data, short typeCode) This version of the constructor can be used to set the string value member variable to the given string.

Method Summary

Modifier and Type	Method and Description
void	decode(Asn1NasDecodeBuffer buffer) This method decodes a 1-octet length, then uses ASCII conversion to convert bytes to characters to populate the string.
void	decode(Asn1OerDecodeBuffer buffer) Decode the value in accordance with OER.
void	decode(Asn1OerDecodeBuffer buffer, int length) Decode the value in accordance with OER.
void	decode(Asn1PerDecodeBuffer buffer) This method decodes an ASN.1 character string value in accordance with the packed encoding rules (PER).
void	decode(Asn1PerDecodeBuffer buffer, Asn1CharSet charSet) This method decodes an ASN.1 character string 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 character string value in accordance with the packed encoding rules (PER).
void	encode(Asn1NasEncodeBuffer buffer) This method encodes a 1-octet length, then uses ASCII conversion to convert characters to bytes, which it encodes.
void	encode(Asn1OerEncodeBuffer buffer) Encode the value in accordance with OER.
void	encode(Asn1OerEncodeBuffer buffer, boolean withLength) Encode the string, with or without a length determinant.
void	encode(Asn1PerEncodeBuffer buffer) This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerEncodeBuffer buffer, Asn1CharSet charSet) This method encodes an ASN.1 character string 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 character string value in accordance with the packed encoding rules (PER).
void	encode(Asn1PerOutputStream out) This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER) directly into the stream.
void	encode(Asn1PerOutputStream out, Asn1CharSet charSet) This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER) directly into the stream.
void	encode(Asn1PerOutputStream out, Asn1CharSet charSet, long lower, long upper) This overloaded version of the encode method encodes an ASN.1 character string value directly into the stream, in accordance with the packed encoding rules (PER).
static void	skip(Asn1PerDecodeBuffer buffer, Asn1CharSet charSet) This method decodes an ASN.1 character string value in accordance with the packed encoding rules (PER).

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

decode, decode, decode, decode, decodeByteToChar, decodeInternal, decodeXER, decodeXML, encode, encode, encode, encode, encode, encode, encode, equals, equals, getAsn1TypeName, getLength, hashCode, toString, validate

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

_setKey, _setLicLocation, clone, decode, decode, decode, decode, decode, decode, decode, decode, decode, decode, encode, encode, encode, encode, encode, encode, encodeAsOpenType, equals, getNonParameterizedTypeName, getTypeName, indent, indent, isOpenType, matchTag, matchTag, pdiag, print, print, print, setNonParameterizedTypeName, setOpenType

Methods inherited from class java.lang.Object

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

Field Detail

BITSPERCHAR_A

public static final int BITSPERCHAR_A

The BITSPERCHAR_A constant specifies the number of bits per character for PER (aligned).

See Also:

Constant Field Values

BITSPERCHAR_U

public static final int BITSPERCHAR_U

The BITSPERCHAR_U constant specifies the number of bits per character for PER (unaligned).

See Also:

Constant Field Values

Constructor Detail

Asn18BitCharString

protected Asn18BitCharString(short typeCode)

The default constructor creates an empty string object.

Parameters:

typeCode - Universal ID code for ASN.1 character string

Asn18BitCharString

protected Asn18BitCharString(java.lang.String data,
                             short typeCode)

This version of the constructor can be used to set the string value member variable to the given string.

Parameters:

data - Character string

typeCode - Universal ID code for ASN.1 character string

Method Detail

decode

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

This method decodes an ASN.1 character string 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 in the Asn1CharString base class.

Specified by:

decode in interface Asn1TypeIF

Overrides:

decode in class Asn1Type

Parameters:

buffer - Decode message buffer object

Throws:

java.io.IOException - for I/O exception

Asn1Exception

decode

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

This method decodes an ASN.1 character string 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. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public value member variable in the Asn1CharString base class.

Parameters:

buffer - Decode message buffer object

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

Throws:

java.io.IOException - for I/O exception

Asn1Exception

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 character string value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present and an optional permitted alphabet constraint. The decoded result is stored in the public value member variable in the Asn1CharString base class.

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:

java.io.IOException - for I/O exception

Asn1Exception

encode

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

This method encodes an ASN.1 character string 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 in the Asn1CharString base class.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

Throws:

java.io.IOException - for I/O exception

Asn1Exception

encode

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

This method encodes an ASN.1 character string 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 in the Asn1CharString base class.

Parameters:

buffer - Encode message buffer object

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

Throws:

java.io.IOException - for I/O exception

Asn1Exception

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 character string value in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present and an optional permitted alphabet constraint. The value to encode is stored in the public value member variable in the Asn1CharString base class.

Parameters:

buffer - Encode 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:

java.io.IOException - for I/O exception

Asn1Exception

skip

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

This method decodes an ASN.1 character string 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. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public value member variable in the Asn1CharString base class.

Parameters:

buffer - Decode message buffer object

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

Throws:

java.io.IOException - for I/O exception

Asn1Exception

encode

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

This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER) directly into the stream. This version of the method assumes no permitted alphabet or size constraints. The value to encode is stored in the public value member variable in the Asn1CharString base class.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

out - PER Encode message 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 character string value in accordance with the packed encoding rules (PER) directly into the stream. 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 in the Asn1CharString base class.

Parameters:

out - PER Encode message 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 character string value directly into the stream, in accordance with the packed encoding rules (PER). This version of the method assumes a size constraint is present and an optional permitted alphabet constraint. The value to encode is stored in the public value member variable in the Asn1CharString base class.

Parameters:

out - PER Encode message stream object

charSet - Object representing 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.

decode

public void decode(Asn1OerDecodeBuffer buffer)
            throws java.io.IOException

Decode the value in accordance with OER. This class's implementation decodes the string with a length determinant. If a subclass should be decoded without a length determinant, it should override this method to invoke decode(buffer, length). Subclasses may override this to add constraint checks after invoking this method to decode the string.

Overrides:

decode in class Asn1Type

Parameters:

buffer - The buffer to decode from.

Throws:

java.io.IOException - for I/O exception

decode

public final void decode(Asn1OerDecodeBuffer buffer,
                         int length)
                  throws java.io.IOException

Decode the value in accordance with OER. This class's implementation decodes a string of the given length. This method is final as I don't see any reason for overriding it.

Parameters:

buffer - The buffer to decode from.

length - Length of string to decode

Throws:

java.io.IOException - for I/O exception

encode

public void encode(Asn1OerEncodeBuffer buffer)
            throws java.io.IOException

Encode the value in accordance with OER. This class's implementation invokes encode(buffer, true) to encode the string with a length determinant. If a subclass should be encoded without a length determinant, it should override this to invoke encode(buffer, false).

Overrides:

encode in class Asn1Type

Parameters:

buffer - The buffer to encode to.

Throws:

java.io.IOException - for I/O exception

encode

public void encode(Asn1OerEncodeBuffer buffer,
                   boolean withLength)
            throws java.io.IOException

Encode the string, with or without a length determinant. Subclasses may override this (e.g. to add constraint checks) and invoke this method to perform the encoding.

Parameters:

buffer - The buffer to encode to.

withLength - true if a length determinant should be encoded.

Throws:

java.io.IOException - for I/O exception

decode

public void decode(Asn1NasDecodeBuffer buffer)
            throws java.io.IOException

This method decodes a 1-octet length, then uses ASCII conversion to convert bytes to characters to populate the string.

Overrides:

decode in class Asn1Type

Parameters:

buffer - NAS decode buffer object

Throws:

java.io.IOException

encode

public void encode(Asn1NasEncodeBuffer buffer)
            throws java.io.IOException

This method encodes a 1-octet length, then uses ASCII conversion to convert characters to bytes, which it encodes.

Overrides:

encode in class Asn1Type

Parameters:

buffer - NAS Encode message buffer object

Throws:

java.io.IOException