com.objsys.asn1j.runtime

Class Asn1Real

java.lang.Object

com.objsys.asn1j.runtime.Asn1Type

com.objsys.asn1j.runtime.Asn1Real

All Implemented Interfaces:

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

Direct Known Subclasses:

Asn1BigDecimal, Asn1RealBase2

public class Asn1Real
extends Asn1Type

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	ANY_BASE
protected int	ANY_BINARY
protected int	BASE_2_ONLY
static Asn1Tag	TAG The TAG constant describes the universal tag for this data type (UNIVERSAL 9).
double	value This public member variable is where the double 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, 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
Asn1Real() The default constructor sets the double value to zero.
Asn1Real(boolean floatType) Deprecated. use Asn1Real() or Asn1Real(double) instead.
Asn1Real(double value_) This constructor creates an REAL object from a double value.

Method Summary

Modifier and Type	Method and Description
void	decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength) This method decodes an ASN.1 REAL value including the UNIVERSAL tag value and length if explicit tagging is specified.
protected void	decode(Asn1DecodeBuffer buffer, int length, int baseflag) This method decodes the content octets of an ASN.1 REAL value into this object, where the REAL was encoded as for BER and the length is taken to be as given.
void	decode(Asn1JsonDecodeBuffer buffer) Decode ASN.1 REAL from JSON.
void	decode(Asn1OerDecodeBuffer buffer) Decode a REAL value, encoded according to OER, into this object.
void	decode(Asn1PerDecodeBuffer buffer) This method decodes ASN.1 REAL value using the Packed Encoding Rules (PER).
protected void	decode(Asn1PerDecodeBuffer buffer, int baseflag) This method decodes ASN.1 REAL value using the Packed Encoding Rules (PER).
void	decodeDouble(Asn1OerDecodeBuffer buffer) Decode a REAL value, encoded according to OER in double precision format.
void	decodeSingle(Asn1OerDecodeBuffer buffer) Decode a REAL value, encoded according to OER in single precision format.
void	decodeV72(Asn1JsonDecodeBuffer buffer) Decode ASN.1 REAL from JSON.
void	decodeXER(java.lang.String buffer, java.lang.String attrs, boolean decodingElemName, boolean modifiedEncodings) This method decodes an ASN.1 real value using XER.
void	decodeXML(java.lang.String buffer, java.lang.String attrs) This method decodes an ASN.1 real value using the XML schema encoding rules.
int	encode(Asn1BerEncodeBuffer buffer, boolean explicit) This method encodes an ASN.1 REAL 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 real value including the UNIVERSAL tag value and length if explicit tagging is specified.
void	encode(Asn1JsonOutputStream outstream) Encode this ASN.1 real value to JSON.
void	encode(Asn1OerEncodeBuffer buffer) Encode this REAL value, according to OER, into the buffer.
void	encode(Asn1PerEncodeBuffer buffer) This method encodes ASN.1 REAL value using the Packed Encoding Rules (PER).
void	encode(Asn1PerOutputStream out) This method encodes ASN.1 REAL value using the Packed Encoding Rules (PER).
void	encode(Asn1XerEncoder buffer, java.lang.String elemName) This method encodes an ASN.1 real 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 real value according to Obj-Sys encoding rules.
void	encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix, boolean asText) This method encodes an ASN.1 real value according to XER encoding rules.
void	encodeAttribute(Asn1XmlEncoder buffer, java.lang.String attrName) This method encodes an ASN.1 real value using the XML Encoding as specified in the W3C XML schema standard(asn2xsd).
void	encodeDouble(Asn1OerEncodeBuffer buffer) Encode this REAL value, according to OER, in double precision format, into the buffer.
void	encodeSingle(Asn1OerEncodeBuffer buffer) Encode this REAL value, according to OER, in single precision format, into the buffer.
void	encodeV72(Asn1JsonOutputStream outstream) Encode this ASN.1 real value to JSON.
void	encodeValue(Asn1XmlEncoder buffer) This method encodes an ASN.1 real value using the XML encoding (non-XER).
boolean	equals(double dvalue) This method compares this REAL value to the given value for equality.
boolean	equals(java.lang.Object o) This method compares this REAL value to the given Object for equality.
java.lang.String	getAsn1TypeName() Returns the ASN.1 type name.
int	hashCode() Returns the hash code for this REAL object.
static java.lang.String	normalizedRealValueToString(double value) This method will return a string representation of the normalized REAL value.
static void	skip(Asn1PerDecodeBuffer buffer) This method skips a REAL value using the Packed Encoding Rules (PER).
java.lang.String	toString() This method will return a string representation of the REAL value.

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, encodeAsOpenType, equals, getLength, 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

TAG

public static final Asn1Tag TAG

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

value

public transient double value

This public member variable is where the double 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.

ANY_BASE

protected int ANY_BASE

ANY_BINARY

protected int ANY_BINARY

BASE_2_ONLY

protected int BASE_2_ONLY

Constructor Detail

Asn1Real

public Asn1Real()

The default constructor sets the double value to zero.

Asn1Real

public Asn1Real(double value_)

This constructor creates an REAL object from a double value.

Parameters:

value_ - double value

Asn1Real

public Asn1Real(boolean floatType)

Deprecated. use Asn1Real() or Asn1Real(double) instead.

Parameters:

floatType - ignored

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

decode

protected final void decode(Asn1DecodeBuffer buffer,
                            int length,
                            int baseflag)
                     throws java.io.IOException

This method decodes the content octets of an ASN.1 REAL value into this object, where the REAL was encoded as for BER and the length is taken to be as given. Note that this method is used for OER also, since OER uses the same content octets as BER, at least in certain cases.

Parameters:

buffer - Decode message buffer object

length - Length of contents

baseflag - ANY_BASE: encoding may use any base ANY_BINARY: encoding may any of bases 2, 8, 16 BASE_2_ONLY: encoding may only use base 2

Throws:

java.io.IOException - for any I/O error

decode

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

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

buffer - Encode message buffer object

explicit - Flag indicating explicit tagging should be done

Returns:

Length of component or negative status value

Throws:

Asn1Exception

decode

protected final void decode(Asn1PerDecodeBuffer buffer,
                            int baseflag)
                     throws Asn1Exception,
                            java.io.IOException

This method decodes ASN.1 REAL value using the Packed Encoding Rules (PER). The length and contents components of the message are decoded. The decoded result is stored in the public member 'value' in this object.

Parameters:

buffer - PER Decode message buffer object

baseflag - ANY_BASE: encoding may use base 2 or base 10 BASE_2_ONLY: encoding may only use base 2

Throws:

java.io.IOException - for any I/O error

Asn1Exception

decode

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

This method decodes ASN.1 REAL value using the Packed Encoding Rules (PER). The length and contents components of the message are decoded. 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 ASN.1 REAL value using the Packed Encoding Rules (PER). The length and contents components of the message are encoded.

Specified by:

encode in interface Asn1TypeIF

Overrides:

encode in class Asn1Type

Parameters:

buffer - PER Encode message buffer object

Throws:

Asn1Exception

java.io.IOException

skip

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

This method skips a REAL value using the Packed Encoding Rules (PER). The length and contents components are skipped.

Parameters:

buffer - PER Decode message buffer object

Throws:

Asn1Exception

java.io.IOException

decode

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

Decode a REAL value, encoded according to OER, into this object. This method applies to unconstrained REAL values and REAL values that are constrained but not meeting the requirements for encoding using IEEE 754 single or double precision format.

Overrides:

decode in class Asn1Type

Parameters:

buffer - The decode buffer.

Throws:

java.io.IOException - for any I/O error

decodeSingle

public final void decodeSingle(Asn1OerDecodeBuffer buffer)
                        throws java.io.IOException

Decode a REAL value, encoded according to OER in single precision format.

Parameters:

buffer - The decode buffer.

Throws:

java.io.IOException - for any I/O error

decodeDouble

public final void decodeDouble(Asn1OerDecodeBuffer buffer)
                        throws java.io.IOException

Decode a REAL value, encoded according to OER in double precision format.

Parameters:

buffer - The decode buffer.

Throws:

java.io.IOException - for any I/O error

encode

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

Encode this REAL value, according to OER, into the buffer. This method applies to unconstrained REAL values and REAL values that are constrained but not meeting the requirements for encoding using IEEE 754 single or double precision format.

Overrides:

encode in class Asn1Type

Parameters:

buffer - The encode buffer.

Throws:

java.io.IOException

encodeSingle

public final void encodeSingle(Asn1OerEncodeBuffer buffer)

Encode this REAL value, according to OER, in single precision format, into the buffer.

Parameters:

buffer - The encode buffer.

encodeDouble

public final void encodeDouble(Asn1OerEncodeBuffer buffer)

Encode this REAL value, according to OER, in double precision format, into the buffer.

Parameters:

buffer - The encode buffer.

encode

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

This method encodes an ASN.1 real 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,
                      boolean decodingElemName,
                      boolean modifiedEncodings)
               throws Asn1Exception

This method decodes an ASN.1 real value using XER.

Parameters:

buffer - String containing data to be decoded

attrs - Attributes string from element tag

decodingElemName - Pass true if you the ASN.1 value being decoded was encoded as an empty element and buffer is the element name. Such an encoding occurs for the special real values under basic-XER, canonical-XER, and extended-XER without GLOBAL-DEFAULTS MODIFIED-ENCODINGS present.

modifiedEncodings - Pass true if decoding under extended-XER with GLOBAL-DEFAULTS MODIFIED-ENCODINGS present.

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 real value according to Obj-Sys encoding rules. The value is encoded as text.

Overrides:

encode in class Asn1Type

Parameters:

buffer - Encode message buffer object

elemName - Element name

nsPrefix - Element namespace prefix value

Throws:

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

Asn1Exception - Thrown, if operation is failed.

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 real value according to XER encoding rules. It is for use with extended-XER.

Parameters:

buffer - Encode message buffer object

elemName - Element name

nsPrefix - Namespace prefix for element.

asText - If TRUE, encode special values as text. Otherwise, special values are encoded as empty elements.

Throws:

java.io.IOException - for any I/O error

Asn1Exception

encodeAttribute

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

This method encodes an ASN.1 real 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 - for any I/O error

Asn1Exception

encodeValue

public void encodeValue(Asn1XmlEncoder buffer)
                 throws java.io.IOException,
                        Asn1Exception

This method encodes an ASN.1 real value using the XML encoding (non-XER).

Parameters:

buffer - Encode message buffer object

Throws:

java.io.IOException - for any I/O error

Asn1Exception

decodeXML

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

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

decodeV72

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

Decode ASN.1 REAL from JSON. This provides ObjSys-specific behavior that predates ITU-T X.697.

Parameters:

buffer - The decode buffer.

Throws:

java.io.IOException - for any I/O error

encodeV72

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

Encode this ASN.1 real value to JSON. This provides ObjSys-specific behavior that predates ITU-T X.697.

Parameters:

outstream - The output stream.

Throws:

java.io.IOException - for any I/O error

decode

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

Decode ASN.1 REAL from JSON.

Overrides:

decode in class Asn1Type

Parameters:

buffer - The decode buffer.

Throws:

java.io.IOException - for any I/O error

encode

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

Encode this ASN.1 real value to JSON.

Overrides:

encode in class Asn1Type

Parameters:

outstream - The output stream.

Throws:

java.io.IOException - for any I/O error

equals

public boolean equals(double dvalue)

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

Parameters:

dvalue - REAL test value

Returns:

true if the values are equal

equals

public boolean equals(java.lang.Object o)

This method compares this REAL value to the given Object for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns the hash code for this REAL object.

Overrides:

hashCode in class Asn1Type

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

Stringified representation of the value

normalizedRealValueToString

public static java.lang.String normalizedRealValueToString(double value)

This method will return a string representation of the normalized REAL value. The output format is [-]X.XXXXE[-]XXX. The format is the ASN.1 value format for this type. This means it is a "NumericRealValue" as defined in X.680. Additionally, if there is a leading minus sign, there will be no whitespace between it and the first digit of the integer part, making it also an "XMLNumericRealValue".

Parameters:

value - value to be normalized and stringified.

Returns:

the string described above

encode

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

This method encodes and writes to the stream an ASN.1 real 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 ASN.1 REAL value using the Packed Encoding Rules (PER). The length and contents components of the message are encoded.

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.