com.objsys.asn1j.runtime

Class Asn1EncodeByteBuffer

java.lang.Object

com.objsys.asn1j.runtime.Asn1MessageBufferBase

com.objsys.asn1j.runtime.Asn1MessageBuffer

com.objsys.asn1j.runtime.Asn1EncodeBuffer

com.objsys.asn1j.runtime.Asn1EncodeByteBuffer

Direct Known Subclasses:

Asn1XerEncodeBuffer, Asn1XmlEncodeBuffer

public abstract class Asn1EncodeByteBuffer
extends Asn1EncodeBuffer

An encoding buffer that is byte-oriented. This is usefule for encodings such as XML, where no part of the encoding consists of partial bytes. This is much the same as Asn1EncodeBitBuffer except that no bit offset needs to be taken into account.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mByteIndex
protected byte[]	mData

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

INITIAL_SIZE

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

context, mTypeCode

Constructor Summary

Constructors

Constructor and Description
Asn1EncodeByteBuffer() The default constructor initializes the encode buffer to the default buffer size (INITIAL_SIZE bytes).
Asn1EncodeByteBuffer(int size) This constructor allows specification of the initial size.

Method Summary

Modifier and Type	Method and Description
protected void	checkSize(int bytesRequired) This method determines if the encode buffer can hold the requested number of bytes.
void	copy(byte value) This method is used to copy a single byte to the encode buffer.
void	copy(byte[] value) This method copies multiple bytes to the encode buffer.
void	copy(byte[] value, int off, int len) This method copies multiple bytes to the encode buffer.
protected void	copyUnsafe(byte value) This method is used to copy a single byte to the encode buffer, without checking whether there is room or not.
byte[]	getBuffer() This method returns a reference to the byte buffer used to hold the encoded message.
java.io.ByteArrayInputStream	getByteArrayInputStream() This method returns a reference to a byte array input stream representing the encoded message.
byte[]	getMsgCopy() This method returns the encoded message in a byte array.
int	getMsgLength() This method returns the length (in bytes) of the encoded message component.
protected void	initBuffer(int size)
void	reset() This method resets the buffer to allow a new record to be encoded into it.
void	write(java.io.OutputStream out) This method writes the encoded record to the given output stream.

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

binDump, binDump, encodeIntSigned, encodeIntUnsigned, getInputStream, getMinimalOctetsSigned, getMinimalOctetsUnsigned, getOutputStream, hexDump, hexDump

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

addNamedEventHandler, getEventHandlerListCount, hasEventHandlers, invokeCharacters, invokeEndElement, invokeStartElement, setEventHandlerList

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

getContext, hexDump, hexDump, setKey, setTypeCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mByteIndex

protected int mByteIndex

mData

protected byte[] mData

Constructor Detail

Asn1EncodeByteBuffer

public Asn1EncodeByteBuffer()

The default constructor initializes the encode buffer to the default buffer size (INITIAL_SIZE bytes).

Asn1EncodeByteBuffer

public Asn1EncodeByteBuffer(int size)

This constructor allows specification of the initial size. This overrides the INITIAL_SIZE constant value.

Parameters:

size - initial Buffer size

Method Detail

checkSize

protected void checkSize(int bytesRequired)

This method determines if the encode buffer can hold the requested number of bytes. If not, the buffer is expanded. This implementation is shared by the Xml and Xer subclasses. It assumes that the location at mByteIndex is not used, and that the array is filling from 0..n. Ber and Per override this method with slightly different behavior.

Parameters:

bytesRequired - Number of required bytes.

copy

public void copy(byte value)

This method is used to copy a single byte to the encode buffer. It first converts the byte to a hex character representation and then copies it to the output buffer.

Specified by:

copy in class Asn1EncodeBuffer

Parameters:

value - The byte value to copy

copy

public void copy(byte[] value)
          throws Asn1Exception

This method copies multiple bytes to the encode buffer. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Overrides:

copy in class Asn1EncodeBuffer

Parameters:

value - Array of bytes to copy to the encode buffer

Throws:

Asn1Exception

copy

public void copy(byte[] value,
                 int off,
                 int len)
          throws Asn1Exception

This method copies multiple bytes to the encode buffer. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Specified by:

copy in class Asn1EncodeBuffer

Parameters:

value - Array of bytes to copy to the encode buffer

off - Starting offset in array

len - The length to be encoded

Throws:

Asn1Exception

copyUnsafe

protected void copyUnsafe(byte value)

This method is used to copy a single byte to the encode buffer, without checking whether there is room or not. The caller is responsible for ensuring the buffer is large enough. This can be useful to avoid multiple size checks when multiple bytes will be copied.

Parameters:

value - The byte value to copy

getByteArrayInputStream

public java.io.ByteArrayInputStream getByteArrayInputStream()

This method returns a reference to a byte array input stream representing the encoded message. This is the preferred way to access the contents of the encoded message as it is the most efficient.

Specified by:

getByteArrayInputStream in class Asn1EncodeBuffer

Returns:

byte array input stream containing encoded message

getBuffer

public byte[] getBuffer()

This method returns a reference to the byte buffer used to hold the encoded message.

Returns:

Byte buffer reference

getMsgCopy

public final byte[] getMsgCopy()

This method returns the encoded message in a byte array. This is less efficient than the getInputStream method because the message contents must be copied to a newly created byte array.

Specified by:

getMsgCopy in class Asn1EncodeBuffer

Returns:

byte array containing encoded message

getMsgLength

public int getMsgLength()

Description copied from class: Asn1EncodeBuffer

This method returns the length (in bytes) of the encoded message component.

Specified by:

getMsgLength in class Asn1EncodeBuffer

Returns:

length of encoded message component

initBuffer

protected void initBuffer(int size)

reset

public void reset()

Description copied from class: Asn1EncodeBuffer

This method resets the buffer to allow a new record to be encoded into it. Any previously encoded data is lost.

Specified by:

reset in class Asn1EncodeBuffer

write

public final void write(java.io.OutputStream out)
                 throws java.io.IOException

This method writes the encoded record to the given output stream.

Specified by:

write in class Asn1EncodeBuffer

Parameters:

out - Output stream to which record is to be written

Throws:

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