Top Description Fields Constructors Methods
org.bouncycastle.util.io

public Class BufferingOutputStream

extends OutputStream
Class Inheritance
Imports
java.io.IOException, .OutputStream, org.bouncycastle.util.Arrays
An output stream that buffers data to be feed into an encapsulated output stream.

The stream zeroes out the internal buffer on each flush.

Field Summary

Modifier and TypeField and Description
private final byte[]
buf

private int
bufOff

private final OutputStream
other

Constructor Summary

AccessConstructor and Description
public
BufferingOutputStream(OutputStream
output stream to be wrapped.
other)

Create a buffering stream with the default buffer size (4096).

public
BufferingOutputStream(OutputStream
output stream to be wrapped.
other, int
size in bytes for internal buffer.
bufferSize)

Create a buffering stream with a specified buffer size.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.
public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flush the internal buffer to the encapsulated output stream.
public void
write(byte[]
the data.
bytes, int
the start offset in the data.
offset, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.
public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.
Inherited from java.io.OutputStream:
nullOutputStreamwrite

Field Detail

bufback to summary
private final byte[] buf
bufOffback to summary
private int bufOff
otherback to summary
private final OutputStream other

Constructor Detail

BufferingOutputStreamback to summary
public BufferingOutputStream(OutputStream other)

Create a buffering stream with the default buffer size (4096).

Parameters
other:OutputStream

output stream to be wrapped.

BufferingOutputStreamback to summary
public BufferingOutputStream(OutputStream other, int bufferSize)

Create a buffering stream with a specified buffer size.

Parameters
other:OutputStream

output stream to be wrapped.

bufferSize:int

size in bytes for internal buffer.

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions
IOException:
if an I/O error occurs.
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flush the internal buffer to the encapsulated output stream. Zero the buffer contents when done.

Exceptions
IOException:
on error.
writeback to summary
public void write(byte[] bytes, int offset, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
bytes:byte[]

the data.

offset:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.