xmlBlaster 2.1.0 API

org.xmlBlaster.util.xbformat
Class ByteArray

java.lang.Object
  extended by java.io.OutputStream
      extended by org.xmlBlaster.util.xbformat.ByteArray
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable

public class ByteArray
extends java.io.OutputStream

Derived from Suns ByteArrayOutputStream, added method insert() and toByteArray(int len). Removed synchronized - this is not thread save anymore but better performing!

This class implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it. The data can be retrieved using toByteArray() and toString().

Closing a ByteArray has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Since:
JDK1.0
Version:
1.45, 12/03/01
Author:
Arthur van Hoff

Field Summary
protected  byte[] buf
          The buffer where data is stored.
protected  int count
          The number of valid bytes in the buffer.
 
Constructor Summary
ByteArray()
          Creates a new byte array output stream.
ByteArray(int size)
          Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
ByteArray(int size, java.io.InputStream is)
          xmlBlaster extension: Read all from is into a byte[] until EOF==-1 arrives.
 
Method Summary
 void close()
          Closing a ByteArray has no effect.
 byte[] getByteArray()
          Get the inner byte array buffer, handle with care.
 void insert(int index, byte b)
          Insert byte at position
 void insert(int index, byte[] b)
          Insert byte at position
 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.
 byte[] toByteArray(int len)
          Get from current position the len bytes
 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(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

ByteArray

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


ByteArray

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

ByteArray

public ByteArray(int size,
                 java.io.InputStream is)
          throws java.io.IOException
xmlBlaster extension: Read all from is into a byte[] until EOF==-1 arrives.

Parameters:
size -
is -
Throws:
java.io.IOException
Method Detail

toByteArray

public byte[] toByteArray(int len)
Get from current position the len bytes


getByteArray

public byte[] getByteArray()
Get the inner byte array buffer, handle with care. AWARE: The buf.length is usually longer than size() and you should not access past the size() end.


insert

public void insert(int index,
                   byte b)
Insert byte at position


insert

public void insert(int index,
                   byte[] b)
Insert byte at position


write

public final 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 final 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.


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.

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.

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

close

public void close()
           throws java.io.IOException
Closing a ByteArray 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
Throws:
java.io.IOException

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.