ByteOutputBuffer

java.lang.Object
- java.io.OutputStream
- - com.neuron.io.ByteOutputBuffer

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public final class ByteOutputBuffer
extends java.io.OutputStream
```
ByteOutputBuffer is very similar in spirit to Java's ByteArrayOutputStream but is significantly more efficient for large amounts of data. It provides utility methods for efficiently writing the accumulated byte buffer to other OutputStreams and a reset() method to re-usability. In addition, it allows for stateful reading of the accumulated buffer even while the buffer may still be in use.

Constructor Summary

Constructors
Constructor and Description
`ByteOutputBuffer()` Create a new ByteOutputBuffer with default initial capacity.
`ByteOutputBuffer(int size)` Create a new ByteOutputBuffer with a specified initial capacity.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()` Returns the number of bytes available for reading.
`void`	`close()` Prevent further writing to this stream.
`void`	`flush()` In ByteOutputBuffer this is a NOOP.
`byte[]`	`getRemainder()` Returns the remaining elements in the buffer from the current read pointer position.
`int`	`read()` Return the next element from the buffer.
`int`	`read(byte[] b)` Read from the buffer into the given byte array.
`int`	`read(byte[] b, int off, int len)` Read from the buffer into the given byte array at a specified offset into the byte array with a given length.
`static byte[]`	`readFully(java.io.InputStream is)` Read an InputStream to it's end and return the resulting byte array.
`void`	`reset()` Reset the ByteOutputBuffer for re-use.
`void`	`resetRead()` Reset the read pointer to the beginning of the buffer.
`int`	`size()` Returns the number of bytes written to the stream since it was created or since it was last reset().
`byte[]`	`toByteArray()` Returns a byte array representation of the currently accumulated stream.
`java.lang.String`	`toString()` Return a string representation of stream's contents.
`java.lang.String`	`toString(java.lang.String encoding)` Return a string representation of stream's contents using a specified String encoding.
`void`	`write(byte[] b)` Write a byte array to the stream.
`void`	`write(byte[] b, int off, int len)` Write a portion of a byte array to the stream.
`void`	`write(int b)` Write a single byte to the stream.
`void`	`writeToStream(java.io.OutputStream out)` Write the entire contents of the stream to another OutputStream.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ByteOutputBuffer
```
public ByteOutputBuffer()
```
    Create a new ByteOutputBuffer with default initial capacity.
  - ByteOutputBuffer
```
public ByteOutputBuffer(int size)
```
    Create a new ByteOutputBuffer with a specified initial capacity.
- Method Detail
  - readFully
```
public static byte[] readFully(java.io.InputStream is)
                        throws java.io.IOException
```
    Read an InputStream to it's end and return the resulting byte array.
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
```
    Reset the ByteOutputBuffer for re-use. All data is discarded.
  - flush
```
public void flush()
           throws java.io.IOException
```
    In ByteOutputBuffer this is a NOOP.
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Overrides:
    
    flush in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Prevent further writing to this stream.
    
    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
  - write
```
public void write(int b)
           throws java.io.IOException
```
    Write a single byte to the stream.
    
    Specified by:
    
    write in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException
  - write
```
public void write(byte[] b)
           throws java.io.IOException
```
    Write a byte array to the stream.
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException
  - write
```
public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
```
    Write a portion of a byte array to the stream.
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException
  - size
```
public int size()
```
    Returns the number of bytes written to the stream since it was created or since it was last reset().
  - writeToStream
```
public void writeToStream(java.io.OutputStream out)
                   throws java.io.IOException
```
    Write the entire contents of the stream to another OutputStream. This is more efficient than using the results of toByteArray() to write to another stream since it does not require the creation of a secondary accumulate array.
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    toByteArray
  - toByteArray
```
public byte[] toByteArray()
```
    Returns a byte array representation of the currently accumulated stream. If the intent is to then write this data to another OutputStream, it is much more efficient to use the writeToStream() method since this method must create a secondary unified array for storage.
    
    See Also:
    
    writeToStream
  - toString
```
public java.lang.String toString()
```
    Return a string representation of stream's contents.
    
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String encoding)
                          throws java.lang.Exception
```
    Return a string representation of stream's contents using a specified String encoding.
    
    Throws:
    
    java.lang.Exception
  - resetRead
```
public void resetRead()
```
    Reset the read pointer to the beginning of the buffer.
  - read
```
public int read()
```
    Return the next element from the buffer.
  - read
```
public int read(byte[] b)
```
    Read from the buffer into the given byte array.
  - read
```
public int read(byte[] b,
                int off,
                int len)
```
    Read from the buffer into the given byte array at a specified offset into the byte array with a given length.
  - getRemainder
```
public byte[] getRemainder()
```
    Returns the remaining elements in the buffer from the current read pointer position.
  - available
```
public int available()
```
    Returns the number of bytes available for reading.

Class ByteOutputBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteOutputBuffer

ByteOutputBuffer

Method Detail

readFully

reset

flush

close

write

write

write

size

writeToStream

toByteArray

toString

toString

resetRead

read

read

read

getRemainder

available