com.objsys.asn1j.runtime
Class Asn1Boolean

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

All Implemented Interfaces:

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

public class Asn1Boolean
extends Asn1Type

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

See Also:

Serialized Form

Field Summary

static Asn1Boolean	FALSE_VALUE The FALSE_VALUE constant represents a boolean FALSE value.
static Asn1Tag	TAG The TAG constant describes the universal tag for this data type (UNIVERSAL 1).
static Asn1Boolean	TRUE_VALUE The TRUE_VALUE constant represents a boolean TRUE value.
boolean	value This public member variable is where the boolean value is stored.

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, mAsn1TypeName, 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

Asn1Boolean()
The default constructor sets the boolean value to false.

Asn1Boolean(boolean value_)
This constructor creates a boolean object from a boolean value.

Method Summary

void	decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength) This method decodes an ASN.1 boolean value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	decode(Asn1JsonDecodeBuffer buffer) Decode ASN.1 BOOLEAN from JSON.
void	decode(Asn1PerDecodeBuffer buffer) This method decodes an ASN.1 boolean value using the Packed Encoding Rules (PER).
void	decodeXER(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 boolean value using the XML encoding rules (XER).
void	decodeXML(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 boolean value using the XML schema encoding rules.
int	encode(Asn1BerEncodeBuffer buffer, boolean explicit) This method encodes an ASN.1 boolean 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 boolean value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	encode(Asn1JsonOutputStream outstream) Encode this boolean value to JSON.
void	encode(Asn1PerEncodeBuffer buffer) This method encodes an ASN.1 boolean value using the Packed Encoding Rules (PER).
void	encode(Asn1PerOutputStream out) This method encodes an ASN.1 boolean value using the Packed Encoding Rules (PER).
void	encode(Asn1XerEncodeBuffer buffer) This method encodes an ASN.1 boolean value using the XML encoding rules (XER).
void	encode(Asn1XerEncoder buffer, java.lang.String elemName) This method encodes an ASN.1 boolean 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 boolean value according to the Obj-Sys XML encoding rules.
void	encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix, boolean asText) This method encodes an ASN.1 boolean value.
void	encodeAttribute(Asn1XmlEncoder buffer, java.lang.String attrName) This method encodes an ASN.1 boolean value using the XML Encoding as specified in the W3C XML schema standard(asn2xsd).
boolean	equals(boolean bvalue) This method compares this boolean value to the given value for equality.
boolean	equals(java.lang.Object bvalue) This method compares this boolean value to the given value for equality.
java.lang.String	getAsn1TypeName() Returns the ASN.1 type name.
int	hashCode() This method returns the hashCode of the current object.
static void	setTrueEncodedByte(byte b) This method sets the byte value that represents the boolean value TRUE.
java.lang.String	toString() This method will return a string representation of the boolean value.

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

clone, decode, decode, decode, decode, decode, encode, encode, equals, getLength, getTypeName, indent, isOpenType, matchTag, matchTag, pdiag, print, setKey, 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 1).

TRUE_VALUE

public static final Asn1Boolean TRUE_VALUE

The TRUE_VALUE constant represents a boolean TRUE value.

FALSE_VALUE

public static final Asn1Boolean FALSE_VALUE

The FALSE_VALUE constant represents a boolean FALSE value.

value

public transient boolean value

This public member variable is where the boolean value is stored. This is the value that is encoded when one of the encode methods is called. It is also where the decoded result is stored when a decode method is called.

Constructor Detail

Asn1Boolean

public Asn1Boolean()

The default constructor sets the boolean value to false.

Asn1Boolean

public Asn1Boolean(boolean value_)

This constructor creates a boolean object from a boolean value.

Parameters:

value_ - Boolean value

Method Detail

getAsn1TypeName

public java.lang.String getAsn1TypeName()

Returns the ASN.1 type name.

Overrides:

getAsn1TypeName in class Asn1Type

Returns:

The ASN.1 type name BOOLEAN.

decode

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

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

The decoded result is stored in the public member value in this object.

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

setTrueEncodedByte

public static void setTrueEncodedByte(byte b)

This method sets the byte value that represents the boolean value TRUE. If a zero byte (0x00) is passed, the value is transparently set to 0xFF, a valid representation in BER, CER, and DER.

Parameters:

b - The byte value to set.

encode

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

This method encodes an ASN.1 boolean value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER) or the Distinguished Encoding Rules (DER).

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 boolean value using the Packed Encoding Rules (PER).

The decoded result is stored in the public member value in this object.

Specified by:

decode in interface Asn1TypeIF

Overrides:

decode in class Asn1Type

Parameters:

buffer - PER 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 boolean value using the Packed Encoding Rules (PER).

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - PER Encode message buffer object

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 boolean 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.

encode

public void encode(Asn1XerEncodeBuffer buffer)
            throws Asn1Exception

This method encodes an ASN.1 boolean value using the XML encoding rules (XER). This method does not add start and end tags ( and ), only value is encoded ( or ).

Parameters:

buffer - Encode message buffer object

Throws:

Asn1Exception

decodeXER

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

This method decodes an ASN.1 boolean 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 boolean value according to the Obj-Sys XML encoding rules. It encodes the value as XML text.

Parameters:

buffer - Encode message buffer object

elemName - Element name for optional surrounding element.

nsPrefix - XML element name space prefix

Throws:

java.io.IOException

Asn1Exception

encode

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

This method encodes an ASN.1 boolean value. It is for use with extended-XER.

Parameters:

buffer - Encode message buffer object

elemName - Element name for optional surrounding element.

nsPrefix - XML element name space prefix

asText - If true, encode as text. Otherwise, encode as an empty element.

Throws:

java.io.IOException

Asn1Exception

encodeAttribute

public void encodeAttribute(Asn1XmlEncoder buffer,
                            java.lang.String attrName)
                     throws java.io.IOException,
                            Asn1Exception

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

Parameters:

buffer - Encode message buffer object

attrName - Attribute name

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 boolean 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 BOOLEAN from JSON.

Parameters:

buffer -

Throws:

java.io.IOException

encode

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

Encode this boolean value to JSON.

Throws:

java.io.IOException

equals

public boolean equals(boolean bvalue)

This method compares this boolean value to the given value for equality.

Parameters:

bvalue - Boolean test value (boolean value)

equals

public boolean equals(java.lang.Object bvalue)

This method compares this boolean value to the given value for equality.

Overrides:

equals in class java.lang.Object

Parameters:

bvalue - Boolean test value (Asn1Boolean object)

hashCode

public int hashCode()

This method returns the hashCode of the current object.

Overrides:

hashCode in class Asn1Type

toString

public java.lang.String toString()

This method will return a string representation of the boolean 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 boolean 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 boolean value using the Packed Encoding Rules (PER).

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.