co.codewizards.cloudstore.core.io

Interface IByteArrayOutputStream

All Superinterfaces:

AutoCloseable, IOutputStream

All Known Implementing Classes:

ByteArrayOutputStream

public interface IByteArrayOutputStream
extends IOutputStream

ByteArrayOutputStream-representing interface to be used in API contracts.

See IOutputStream for further details.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Method Summary

Modifier and Type	Method and Description
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.
String	toString(String charsetName) Converts the buffer's contents into a string by decoding the bytes using the named charset.
void	writeTo(IOutputStream 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 interface co.codewizards.cloudstore.core.io.IOutputStream

close, flush, write, write, write

Method Detail

writeTo

void writeTo(IOutputStream out)
      throws 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:

IOException - if an I/O error occurs.

reset

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

toByteArray

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

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

toString

String toString(String charsetName)
         throws UnsupportedEncodingException

Converts the buffer's contents into a string by decoding the bytes using the named charset. 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:

UnsupportedEncodingException - If the named charset is not supported

Since:

JDK1.1