com.objsys.asn1j.runtime

Class Asn1Null

java.lang.Object

com.objsys.asn1j.runtime.Asn1Type

com.objsys.asn1j.runtime.Asn1Null

All Implemented Interfaces:

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

public class Asn1Null
extends Asn1Type

This class represents the ASN.1 NULL built-in type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Asn1Null	NULL_VALUE The NULL_VALUE constant represents a NULL value.
static Asn1Tag	TAG The TAG constant describes the universal tag for this data type (UNIVERSAL 5).

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

Constructor and Description
Asn1Null()

Method Summary

Modifier and Type	Method and Description
void	decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength) This method decodes an ASN.1 null value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	decode(Asn1JsonDecodeBuffer buffer) Decode ASN.1 NULL from JSON.
void	decode(Asn1NasDecodeBuffer buffer) This method is the base implementation of the NAS decode method.
void	decode(Asn1OerDecodeBuffer buffer) Decode ASN.1 NULL type, using Octet Encoding Rules (OER).
void	decode(Asn1PerDecodeBuffer buffer) This method decodes an ASN.1 null value in accordance with the Packed Encoding Rules (PER).
void	decodeXER(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 null value using the XML encoding rules (XER).
void	decodeXML(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 null value using the XML schema encoding rules.
int	encode(Asn1BerEncodeBuffer buffer, boolean explicit) This method encodes an ASN.1 null value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	encode(Asn1BerOutputStream out, boolean explicit) This method encodes and writes to the stream an ASN.1 NULL value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	encode(Asn1JsonOutputStream outstream) Encode this ASN.1 null value to JSON
void	encode(Asn1NasEncodeBuffer buffer) This method is the base implementation of the NAS encode method.
void	encode(Asn1OerEncodeBuffer buffer) Encode ASN.1 NULL type, using Octet Encoding Rules (OER).
void	encode(Asn1PerEncodeBuffer buffer) This method encodes an ASN.1 null value in accordance with the Packed Encoding Rules (PER).
void	encode(Asn1PerOutputStream out) This method encodes an ASN.1 null value in accordance with the Packed Encoding Rules (PER).
void	encode(Asn1XerEncoder buffer, java.lang.String elemName) This method encodes an ASN.1 null 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 null value using the XML Encoding as specified in the XML schema standard(asn2xsd).
boolean	equals(java.lang.Object o) Tests equality.
java.lang.String	getAsn1TypeName() Returns the ASN.1 type name.
java.lang.String	toString() This method will return a string representation of the null value.

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

_setKey, _setLicLocation, clone, decode, decode, decode, decode, decode, decode, decode, decode, decode, encode, encode, encode, encode, encodeAsOpenType, equals, getLength, getNonParameterizedTypeName, getTypeName, hashCode, 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

TAG

public static final Asn1Tag TAG

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

NULL_VALUE

public static final Asn1Null NULL_VALUE

The NULL_VALUE constant represents a NULL value.

Constructor Detail

Asn1Null

public Asn1Null()

Method Detail

equals

public boolean equals(java.lang.Object o)

Tests equality. All NULL values are equal to each other.

Overrides:

equals in class java.lang.Object

getAsn1TypeName

public java.lang.String getAsn1TypeName()

Returns the ASN.1 type name.

Overrides:

getAsn1TypeName in class Asn1Type

Returns:

The ASN.1 type name NULL.

decode

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

This method decodes an ASN.1 null value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER).

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

Throws:

Asn1Exception

java.io.IOException

encode

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

This method encodes an ASN.1 null value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version used the Basic Encoding Rules (BER).

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 null value in accordance with the Packed Encoding Rules (PER).

Specified by:

decode in interface Asn1TypeIF

Overrides:

decode in class Asn1Type

Parameters:

buffer - Decode message buffer object

Throws:

Asn1Exception

java.io.IOException

encode

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

This method encodes an ASN.1 null value in accordance with the Packed Encoding Rules (PER).

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

Throws:

Asn1Exception

java.io.IOException

decode

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

Description copied from class: Asn1Type

This method is the base implementation of the NAS decode method. It throws an exception because it should never be invoked by compiler generated code.

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

Description copied from class: Asn1Type

This method is the base implementation of the NAS encode method. This throws an exception because it should never be invoked by compiler generated code.

Overrides:

encode in class Asn1Type

Parameters:

buffer - NAS Encode message buffer object

Throws:

java.io.IOException

decode

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

Decode ASN.1 NULL type, using Octet Encoding Rules (OER).

Overrides:

decode in class Asn1Type

Parameters:

buffer -

Throws:

java.io.IOException

encode

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

Encode ASN.1 NULL type, using Octet Encoding Rules (OER).

Overrides:

encode in class Asn1Type

Parameters:

buffer -

Throws:

java.io.IOException

encode

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

This method encodes an ASN.1 null 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 null 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 null value using the XML Encoding as specified in the XML schema standard(asn2xsd).

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

elemName - Element name

nsPrefix - Element namespace prefix

Throws:

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

Asn1Exception - Thrown, if operation is failed.

decodeXML

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

This method decodes an ASN.1 null 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

decode

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

Decode ASN.1 NULL from JSON.

Overrides:

decode in class Asn1Type

Parameters:

buffer -

Throws:

java.io.IOException

encode

public void encode(Asn1JsonOutputStream outstream)
            throws java.io.IOException

Encode this ASN.1 null value to JSON

Overrides:

encode in class Asn1Type

Parameters:

outstream - JSON output stream

Throws:

java.io.IOException

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

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 NULL value 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 null value in accordance with the Packed Encoding Rules (PER).

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.