Android
java.io
public class

java.io.ByteArrayOutputStream

java.lang.Object
java.io.OutputStream Closeable Flushable
java.io.ByteArrayOutputStream

ByteArrayOutputStream is a class whose underlying stream is represented by a byte array. As bytes are written to this stream, the local byte array may be expanded to hold more bytes.

Summary

Fields

protected      byte[]  buf  The byte array containing the bytes written. 
protected      int  count  The number of bytes written. 

Public Constructors

            ByteArrayOutputStream()
Constructs a new ByteArrayOutputStream with a default size of 32 bytes.
            ByteArrayOutputStream(int size)
Constructs a new ByteArrayOutputStream with a default size of size bytes.

Public Methods

          void  close()
Close this ByteArrayOutputStream.
  synchronized        void  reset()
Reset this ByteArrayOutputStream to the beginning of the underlying byte array.
          int  size()
Returns the total number of bytes written to this stream thus far.
  synchronized        byte[]  toByteArray()
Answer the contents of this ByteArrayOutputStream as a byte array.
          String  toString()
Answer the contents of this ByteArrayOutputStream as a String.
          String  toString(String enc)
Answer the contents of this ByteArrayOutputStream as a String converted using the encoding declared in enc.
          String  toString(int hibyte)
This method is deprecated. Use toString()
  synchronized        void  write(int oneByte)
Writes the specified byte oneByte to the OutputStream.
  synchronized        void  write(byte[] buffer, int offset, int len)
Writes count bytes from the byte array buffer starting at offset index to the ByteArrayOutputStream.
  synchronized        void  writeTo(OutputStream out)
Take the contents of this stream and write it to the output stream out.
Methods inherited from class java.io.OutputStream
Methods inherited from class java.lang.Object
Methods inherited from interface java.io.Closeable
Methods inherited from interface java.io.Flushable

Details

Fields

protected byte[] buf

The byte array containing the bytes written.

protected int count

The number of bytes written.

Public Constructors

public ByteArrayOutputStream()

Constructs a new ByteArrayOutputStream with a default size of 32 bytes. If more than 32 bytes are written to this instance, the underlying byte array will expand to accommodate.

public ByteArrayOutputStream(int size)

Constructs a new ByteArrayOutputStream with a default size of size bytes. If more than size bytes are written to this instance, the underlying byte array will expand to accommodate.

Parameters

size an non-negative integer representing the initial size for the underlying byte array.

Public Methods

public void close()

Close this ByteArrayOutputStream. This implementation releases System resources used for this stream.

Throws

IOException If an error occurs attempting to close this OutputStream.

public synchronized void reset()

Reset this ByteArrayOutputStream to the beginning of the underlying byte array. All subsequent writes will overwrite any bytes previously stored in this stream.

public int size()

Returns the total number of bytes written to this stream thus far.

Returns

  • the number of bytes written to this Stream.

public synchronized byte[] toByteArray()

Answer the contents of this ByteArrayOutputStream as a byte array. Any changes made to the receiver after returning will not be reflected in the byte array returned to the caller.

Returns

  • this streams current contents as a byte array.

public String toString()

Answer the contents of this ByteArrayOutputStream as a String. Any changes made to the receiver after returning will not be reflected in the String returned to the caller.

Returns

  • this streams current contents as a String.

public String toString(String enc)

Answer the contents of this ByteArrayOutputStream as a String converted using the encoding declared in enc.

Parameters

enc A String representing the encoding to use when translating this stream to a String.

Returns

  • this streams current contents as a String.

Throws

UnsupportedEncodingException If declared encoding is not supported

public String toString(int hibyte)

This method is deprecated. Use toString()

Answer the contents of this ByteArrayOutputStream as a String. Each byte b in this stream is converted to a character c using the following function: c == (char)(((hibyte & 0xff) << 8) | (b & 0xff)). This method is deprecated and either toString(), or toString(String) should be used.

Parameters

hibyte the high byte of each resulting Unicode character

Returns

  • this streams current contents as a String with the high byte set to hibyte

public synchronized void write(int oneByte)

Writes the specified byte oneByte to the OutputStream. Only the low order byte of oneByte is written.

Parameters

oneByte the byte to be written

public synchronized void write(byte[] buffer, int offset, int len)

Writes count bytes from the byte array buffer starting at offset index to the ByteArrayOutputStream.

Parameters

buffer the buffer to be written
offset offset in buffer to get bytes
len number of bytes in buffer to write

Throws

NullPointerException If buffer is null.
IndexOutOfBoundsException If offset or count are outside of bounds.

public synchronized void writeTo(OutputStream out)

Take the contents of this stream and write it to the output stream out.

Parameters

out An OutputStream on which to write the contents of this stream.

Throws

IOException If an error occurs when writing to output stream
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56