org.jlab.coda.jevio

Class EvioByteArrayOutputStream

java.lang.Object

java.io.OutputStream

org.jlab.coda.jevio.EvioByteArrayOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class EvioByteArrayOutputStream
extends java.io.OutputStream

This class is a slightly modified copy of java's ByteArrayOutputStream. Synchronization is removed and direct access to byte array is allowed. A ByteBuffer wrapper around the byte array is added. C. Timmer

It implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it. The data can be retrieved using toByteArray() and toString().

Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Since:

JDK1.0

Author:

Arthur van Hoff

Field Summary

Fields

Modifier and Type	Field and Description
(package private) byte[]	buf The buffer where data is stored.
(package private) java.nio.ByteBuffer	byteBuf Wrapper around buf.
(package private) int	count The number of valid bytes in the buffer.

Constructor Summary

Constructors

Constructor and Description
EvioByteArrayOutputStream(int size) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary

Modifier and Type	Method and Description
void	close() Closing a ByteArrayOutputStream has no effect.
byte[]	getByteArray() Get the current backing byte array.
java.nio.ByteBuffer	getByteBuffer() Get the current backing ByteBuffer (which wraps the byte array).
void	reset() Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded.
int	size() Returns the current size of the buffer.
byte[]	toByteArray() Creates a newly allocated byte array.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
void	write(int b) Writes the specified byte to this byte array output stream.
void	writeTo(java.io.OutputStream out) Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Field Detail

buf

byte[] buf

The buffer where data is stored.

byteBuf

java.nio.ByteBuffer byteBuf

Wrapper around buf.

count

int count

The number of valid bytes in the buffer.

Constructor Detail

EvioByteArrayOutputStream

public EvioByteArrayOutputStream(int size)

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Parameters:

size - the initial size.

Method Detail

write

public void write(int b)

Writes the specified byte to this byte array output stream.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte to be written.

write

public void write(byte[] b,
                  int off,
                  int len)

Writes len bytes from the specified byte array starting at offset off to this byte array output stream.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).

Parameters:

out - the output stream to which to write the data.

Throws:

java.io.IOException - if an I/O error occurs.

reset

public void reset()

Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.

See Also:

ByteArrayInputStream.count

getByteArray

public byte[] getByteArray()

Get the current backing byte array.

Returns:

the current backing byte array of this output stream.

See Also:

ByteArrayOutputStream.size()

getByteBuffer

public java.nio.ByteBuffer getByteBuffer()

Get the current backing ByteBuffer (which wraps the byte array).

Returns:

the current backing ByteBuffer of this output stream.

See Also:

ByteArrayOutputStream.size()

toByteArray

public byte[] toByteArray()

Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.

Returns:

the current contents of this output stream, as a byte array.

See Also:

ByteArrayOutputStream.size()

size

public int size()

Returns the current size of the buffer.

Returns:

the value of the count field, which is the number of valid bytes in this output stream.

close

public void close()
           throws java.io.IOException

Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException