er.extensions.foundation
Class ERXRefByteArrayOutputStream

java.lang.Object
  java.io.OutputStream
      er.extensions.foundation.ERXRefByteArrayOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

public class ERXRefByteArrayOutputStream
extends java.io.OutputStream

This class is uh ... inspired ... by ByteArrayOutputStream, except that it gives direct access to the underlying byte buffer for performing operations on the buffer without a byte array copying penalty.

Author:

Arthur van Hoff, mschrag

Field Summary

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

Constructor Summary

ERXRefByteArrayOutputStream()
Creates a new byte array output stream.

ERXRefByteArrayOutputStream(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[]	getBuffer() Returns the underlying byte buffer for this stream.
void	reset() Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the ouput stream is discarded.
int	size() Returns the current size of the buffer.
byte[]	toByteArray() Creates a newly allocated byte array.
com.webobjects.foundation.NSData	toNSData() Returns a no-copy NSData of the byte buffer for this stream.
java.lang.String	toString() Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.
java.lang.String	toString(int hibyte) Deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.
java.lang.String	toString(java.lang.String enc) Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.
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

ERXRefByteArrayOutputStream

public ERXRefByteArrayOutputStream()

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

ERXRefByteArrayOutputStream

public ERXRefByteArrayOutputStream(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.

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 ouput stream is discarded. The output stream can be used again, reusing the already allocated buffer space.

See Also:

ByteArrayInputStream.count

toByteArray

public 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

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

toString

public java.lang.String toString()

Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.

Overrides:

toString in class java.lang.Object

Returns:

String translated from the buffer's contents.

Since:

JDK1.1

toString

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

Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.

Parameters:

enc - a character-encoding name.

Returns:

String translated from the buffer's contents.

Throws:

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

Since:

JDK1.1

toString

@Deprecated
public java.lang.String toString(int hibyte)

Deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.

Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that:

     c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))
 

Parameters:

hibyte - the high byte of each resulting Unicode character.

Returns:

the current contents of the output stream, as a string.

See Also:

ByteArrayOutputStream.size(), ByteArrayOutputStream.toString(String), ByteArrayOutputStream.toString()

close

public void close()

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

getBuffer

public byte[] getBuffer()

Returns the underlying byte buffer for this stream.

Returns:

the underlying byte buffer for this stream

toNSData

public com.webobjects.foundation.NSData toNSData()

Returns a no-copy NSData of the byte buffer for this stream.

Returns:

a no-copy NSData of the byte buffer for this stream