Asn1PerOutputStream

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.objsys.asn1j.runtime
Class Asn1PerOutputStream

java.lang.Object
  java.io.OutputStream
      com.objsys.asn1j.runtime.Asn1OutputStream
          com.objsys.asn1j.runtime.Asn1PerOutputStream

All Implemented Interfaces:: Asn1PerEncoder, java.io.Closeable, java.io.Flushable

public class Asn1PerOutputStream
extends Asn1OutputStream
implements Asn1PerEncoder
extends Asn1OutputStream
implements Asn1PerEncoder

This class handles the output stream for encoding of ASN.1 messages as specified in the Packed Encoding Rules (PER) ITU-T X.691 standard.

Field Summary
`protected Asn1PerOutputStreamTraceHandler`	`mTraceHandler`

Fields inherited from class com.objsys.asn1j.runtime.Asn1OutputStream
`os`

Constructor Summary
`Asn1PerOutputStream(java.io.OutputStream os, boolean aligned)` This constructor creates a buffered PER output stream object with the default size of buffer.
`Asn1PerOutputStream(java.io.OutputStream os, int bufSize, boolean aligned)` This constructor creates a buffered PER output stream object with the specified size of buffer.

Method Summary
`void`	`addCaptureBuffer(java.io.ByteArrayOutputStream buffer)` This method is used to add a capture buffer to the internal capture buffer list.
`void`	`binDump(java.io.PrintStream out, java.lang.String varName)` This method dumps the encoded message in a human-readable format showing a bit trace of all fields to the given print output stream.
`void`	`binDump(java.lang.String varName)` This method invokes an overloaded version of binDump to dump the encoded message to standard output.
`void`	`byteAlign()` This methods byte-aligns the buffer.
`void`	`close()` Close the stream.
`void`	`encodeBit(boolean value)` This method encodes a single bit value.
`void`	`encodeBit(boolean value, java.lang.String ident)` This method encodes a single bit value.
`void`	`encodeBits(byte[] value, int offset, int nbits)` This method encodes bit values from an array of octets.
`void`	`encodeBits(byte[] value, int offset, int nbits, java.lang.String ident)` This method encodes bit values from an array of octets.
`void`	`encodeBits(byte value, int nbits)` This method encodes bit values from an octet.
`void`	`encodeCharString(java.lang.String value, int nchars, int offset, int abpc, int ubpc, Asn1CharSet charSet)` This method encodes the contents of a known-multiplier character string type.
`void`	`encodeConsWholeNumber(long adjustedValue, long rangeValue)` This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard.
`void`	`encodeConsWholeNumber(long adjustedValue, long rangeValue, java.lang.String ident)` This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard.
`void`	`encodeInt(long value, boolean encodeLen, boolean signExtend)` This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard.
`void`	`encodeInt(long value, boolean encodeLen, boolean signExtend, java.lang.String ident)` This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard.
`void`	`encodeInt(long value, int nbits)` This method encodes bit values from an integer value.
`void`	`encodeInt(long value, int nbits, java.lang.String ident)` This method encodes bit values from an integer value.
`long`	`encodeLength(long value)` This method encodes a general (unconstrained) length determinant value as described in section 10.9 or the X.691 standard.
`void`	`encodeLength(long value, long lower, long upper)` This method encodes a constrained length determinant value.
`void`	`encodeLengthEOM(long value)` This method checks to see if a zero byte needs to be added after a fragmented length has been encoded.
`void`	`encodeOctetString(byte[] value, int offset, int nbytes)` This method encodes the given array of bytes as an unconstrained octet string value.
`void`	`encodeOIDLengthAndValue(int[] value)` This method encodes the length and contents of an object identifier value.
`void`	`encodeOpenType(byte[] value, int offset, int nbytes)` This method encodes the given array of bytes as an open type.
`void`	`encodeRelOIDLengthAndValue(int[] value)` This method encodes the length and contents of a relative object identifier value.
`void`	`encodeSmallLength(int value)` This method implements the rules to encode a normally small length as specified in section 11.9 of the X.691 standard.
`void`	`encodeSmallNonNegWholeNumber(int value)` This method implements the rules to encode a small non-negative whole number as specified in section 10.6 of the X.691 standard.
`void`	`flush()` Flush the buffer to the stream.
`Asn1PerTraceHandler`	`getTraceHandler()` This method will return a reference to the internal trace handler object used to trace the bit fields within a PER message.
`boolean`	`isAligned()` This method is used to test if PER aligned encoding has been specified.
`void`	`removeCaptureBuffer(java.io.ByteArrayOutputStream buffer)` This method is used to remove a capture buffer from the internal capture buffer list.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`void`	`write(int b)` Writes the specified byte to this output stream.

Methods inherited from class com.objsys.asn1j.runtime.Asn1OutputStream
`getContext, write2Bytes, write4Bytes`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

mTraceHandler

protected Asn1PerOutputStreamTraceHandler mTraceHandler

Constructor Detail

Asn1PerOutputStream

public Asn1PerOutputStream(java.io.OutputStream os,
                           boolean aligned)

This constructor creates a buffered PER output stream object with the default size of buffer. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters:: os - The underlying OutputStream object.; aligned - Indicates whether PER aligned or unaligned encoding should be done.

Asn1PerOutputStream

public Asn1PerOutputStream(java.io.OutputStream os,
                           int bufSize,
                           boolean aligned)

This constructor creates a buffered PER output stream object with the specified size of buffer. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters:: os - The underlying OutputStream object.; bufSize - The buffer size.; aligned - Indicates whether PER aligned or unaligned encoding should be done.

Method Detail

getTraceHandler

public Asn1PerTraceHandler getTraceHandler()

This method will return a reference to the internal trace handler object used to trace the bit fields within a PER message.

binDump

public void binDump(java.lang.String varName)

This method invokes an overloaded version of binDump to dump the encoded message to standard output.

binDump

public void binDump(java.io.PrintStream out,
                    java.lang.String varName)

This method dumps the encoded message in a human-readable format showing a bit trace of all fields to the given print output stream.

flush

public void flush()
           throws java.io.IOException

Flush the buffer to the stream. It writes whole bytes only.

Specified by:: flush in interface java.io.Flushable
Overrides:: flush in class Asn1OutputStream

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

close

public void close()
           throws java.io.IOException

Close the stream. Writes all bytes (even unfinished) before closing.

Specified by:: close in interface java.io.Closeable
Overrides:: close in class Asn1OutputStream

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

isAligned

public boolean isAligned()

This method is used to test if PER aligned encoding has been specified.

byteAlign

public void byteAlign()

This methods byte-aligns the buffer.