org.elasticsearch.common.io
Class FastByteArrayOutputStream

java.lang.Object
  java.io.OutputStream
      org.elasticsearch.common.io.FastByteArrayOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

public class FastByteArrayOutputStream
extends java.io.OutputStream

Similar to ByteArrayOutputStream just not synced.

Nested Class Summary

static class

FastByteArrayOutputStream.Cached A thread local based cache of FastByteArrayOutputStream.

Field Summary

protected byte[]	buf The buffer where data is stored.
protected int	count The number of valid bytes in the buffer.

Constructor Summary

FastByteArrayOutputStream()
Creates a new byte array output stream.

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

Method Summary

void	close() Closing a ByteArrayOutputStream has no effect.
byte[]	copiedByteArray() Creates a newly allocated 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.
void	seek(int position) Seeks back to the given position.
int	size() Returns the current size of the buffer.
java.lang.String	toString() Converts the buffer's contents into a string decoding bytes using the platform's default character set.
java.lang.String	toString(java.lang.String charsetName) Converts the buffer's contents into a string by decoding the bytes using the specified charsetName.
byte[]	unsafeByteArray() Returns the underlying 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, wait, wait, wait

Field Detail

buf

protected byte[] buf

The buffer where data is stored.

count

protected int count

The number of valid bytes in the buffer.

Constructor Detail

FastByteArrayOutputStream

public FastByteArrayOutputStream()

Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

FastByteArrayOutputStream

public FastByteArrayOutputStream(int size)

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

Parameters:

size - the initial size.

Throws:

java.lang.IllegalArgumentException - if size is negative.

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. NO checks for bounds, parameters must be ok!

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

copiedByteArray

public byte[] copiedByteArray()

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()

unsafeByteArray

public byte[] unsafeByteArray()

Returns the underlying byte array. Note, use size() in order to know the length of it.

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.

See Also:

ByteArrayOutputStream.count

seek

public void seek(int position)

Seeks back to the given position. Size will become the seeked location.

toString

public java.lang.String toString()

Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String is a function of the character set, and hence may not be equal to the size of the buffer.

This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The CharsetDecoder class should be used when more control over the decoding process is required.

Overrides:

toString in class java.lang.Object

Returns:

String decoded from the buffer's contents.

Since:

JDK1.1

toString

public java.lang.String toString(java.lang.String charsetName)
                          throws java.io.UnsupportedEncodingException

Converts the buffer's contents into a string by decoding the bytes using the specified charsetName. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The CharsetDecoder class should be used when more control over the decoding process is required.

Parameters:

charsetName - the name of a supported charset

Returns:

String decoded from the buffer's contents.

Throws:

java.io.UnsupportedEncodingException - If the named charset is not supported

Since:

JDK1.1

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

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException