summaryrefslogtreecommitdiff
path: root/java/io/ByteArrayOutputStream.java
diff options
context:
space:
mode:
authorTom Tromey <tromey@redhat.com>2000-08-16 01:44:44 +0000
committerTom Tromey <tromey@redhat.com>2000-08-16 01:44:44 +0000
commitd359e9ddf0e8cd77b1f1f0460e7fe144332c35ce (patch)
tree115681a965416965437439ea3cdb53f887dcc389 /java/io/ByteArrayOutputStream.java
parent52b10416e88ebf7cf494e71a2bd1afa619e7a110 (diff)
downloadclasspath-d359e9ddf0e8cd77b1f1f0460e7fe144332c35ce.tar.gz
* ByteArrayOutputStream.java: Merged with libgcj.
Diffstat (limited to 'java/io/ByteArrayOutputStream.java')
-rw-r--r--java/io/ByteArrayOutputStream.java576
1 files changed, 225 insertions, 351 deletions
diff --git a/java/io/ByteArrayOutputStream.java b/java/io/ByteArrayOutputStream.java
index 1e02060e2..5fba5c591 100644
--- a/java/io/ByteArrayOutputStream.java
+++ b/java/io/ByteArrayOutputStream.java
@@ -1,32 +1,20 @@
-/* ByteArrayOutputStream.java -- Write bytes to a buffer
- Copyright (C) 1998, 1999 Free Software Foundation, Inc.
+// ByteArrayOutputStream.java - Write bytes to an array.
-This file is part of GNU Classpath.
+/* Copyright (C) 1998, 1999, 2000 Free Software Foundation
-GNU Classpath is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
-
-GNU Classpath is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with GNU Classpath; see the file COPYING. If not, write to the
-Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-02111-1307 USA.
-
-As a special exception, if you link this library with other files to
-produce an executable, this library does not by itself cause the
-resulting executable to be covered by the GNU General Public License.
-This exception does not however invalidate any other reasons why the
-executable file might be covered by the GNU General Public License. */
+ This file is part of libgcj.
+This software is copyrighted work licensed under the terms of the
+Libgcj License. Please consult the file "LIBGCJ_LICENSE" for
+details. */
package java.io;
+/* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
+ * "The Java Language Specification", ISBN 0-201-63451-1
+ * Status: Complete to version 1.1.
+ */
+
/**
* This class allows data to be written to a byte array buffer and
* and then retrieved by an application. The internal byte array
@@ -35,13 +23,10 @@ package java.io;
* cause large amounts of memory to be allocated.
* <p>
* The size of the internal buffer defaults to 32 and it is resized
- * in increments of 1024 bytes. This behavior can be over-ridden by using the
- * following two properties:
- * <p>
- * <ul>
- * <li><code>gnu.java.io.ByteArrayOutputStream.initialBufferSize</code>
- * <li><code>gnu.java.io.ByteArrayOutputStream.bufferIncrementSize</code>
- * </ul>
+ * by doubling the size of the buffer. This default size can be
+ * overridden by using the
+ * <code>gnu.java.io.ByteArrayOutputStream.initialBufferSize</code>
+ * property.
* <p>
* There is a constructor that specified the initial buffer size and
* that is the preferred way to set that value because it it portable
@@ -55,328 +40,217 @@ package java.io;
* @version 0.0
*
* @author Aaron M. Renn (arenn@urbanophile.com)
+ * @author Tom Tromey <tromey@cygnus.com>
+ * @date September 24, 1998
*/
public class ByteArrayOutputStream extends OutputStream
{
-
-/*************************************************************************/
-
-/*
- * Class Variables
- */
-
-/**
- * The default initial buffer size
- */
-private static final int DEFAULT_INITIAL_BUFFER_SIZE = 32;
-
-/**
- * The default buffer increment size
- */
-private static final int DEFAULT_BUFFER_INCREMENT_SIZE = 1024;
-
-/**
- * The initial size of the internal buffer
- */
-private static int initial_buffer_size;
-
-/**
- * The number of bytes by which the buffer will be enlarged if it
- * is filled up
- */
-private static int buffer_increment_size;
-
-static
-{
- initial_buffer_size = Integer.getInteger(
- "gnu.java.io.ByteArrayOutputStream.initialBufferSize",
- DEFAULT_INITIAL_BUFFER_SIZE).intValue();
- buffer_increment_size = Integer.getInteger(
- "gnu.java.io.ByteArrayOutputStream.bufferIncrementSize",
- DEFAULT_BUFFER_INCREMENT_SIZE).intValue();
-
- if (initial_buffer_size <= 0)
- initial_buffer_size = DEFAULT_INITIAL_BUFFER_SIZE;
- if (buffer_increment_size <= 0)
- buffer_increment_size = DEFAULT_BUFFER_INCREMENT_SIZE;
-}
-
-/*************************************************************************/
-
-/*
- * Instance Variables
- */
-
-/**
- * The internal buffer where the data written is stored
- */
-protected byte[] buf;
-
-/**
- * The number of bytes that have been written to the buffer
- */
-protected int count;
-
-/*************************************************************************/
-
-/*
- * Construtors
- */
-
-/**
- * This method initializes a new <code>ByteArrayOutputStream</code> with
- * the default buffer size of 32 bytes. If a different initial buffer
- * size is desired, see the constructor <code>ByteArrayOutputStream(int size)</code>.
- * For applications where the source code is not available, the default buffer
- * size can be set using the system property
- * <code>gnu.java.io.ByteArrayOutputStream.initialBufferSize</code>
- */
-public
-ByteArrayOutputStream()
-{
- this(initial_buffer_size);
-}
-
-/*************************************************************************/
-
-/**
- * This method initializes a new <code>ByteArrayOutputStream</code> with
- * a specified initial buffer size.
- *
- * @param size The initial buffer size in bytes
- */
-public
-ByteArrayOutputStream(int size)
-{
- buf = new byte[size];
-}
-
-/*************************************************************************/
-
-/*
- * Instance Methods
- */
-
-/**
- * This method closes this output stream and releases any resources
- * associated with it.
- *
- * @exception IOException If an error occurs.
- */
-public void
-close() throws IOException
-{
- super.close();
-}
-
-/*************************************************************************/
-
-/**
- * This method discards all of the bytes that have been written to the
- * internal buffer so far by setting the <code>count</code> variable to
- * 0. The internal buffer remains at its currently allocated size.
- */
-public void
-reset()
-{
- count = 0;
-}
-
-/*************************************************************************/
-
-/**
- * This method returns the number of bytes that have been written to
- * the buffer so far. This is the same as the value of the protected
- * <code>count</code> variable. If the <code>reset</code> method is
- * called, then this value is reset as well. Note that this method does
- * not return the length of the internal buffer, but only the number
- * of bytes that have been written to it.
- *
- * @return The number of bytes in the internal buffer
- *
- * @see reset
- */
-public int
-size()
-{
- return(count);
-}
-
-/*************************************************************************/
-
-/**
- * This method returns a byte array containing the bytes that have been
- * written to this stream so far. This array is a copy of the valid
- * bytes in the internal buffer and its length is equal to the number of
- * valid bytes, not necessarily to the the length of the current
- * internal buffer. Note that since this method allocates a new array,
- * it should be used with caution when the internal buffer is very large.
- */
-public byte[]
-toByteArray()
-{
- byte[] buf = new byte[count];
-
- System.arraycopy(this.buf, 0, buf, 0, count);
-
- return(buf);
-}
-
-/*************************************************************************/
-
-/**
- * Returns the bytes in the internal array as a <code>String</code>. The
- * bytes in the buffer are converted to characters using the system default
- * encoding. There is an overloaded <code>toString()</code> method that
- * allows an application specified character encoding to be used.
- *
- * @return A <code>String</code> containing the data written to this stream so far
- */
-public String
-toString()
-{
- return(new String(toByteArray()));
-}
-
-/*************************************************************************/
-
-/**
- * Returns the bytes in the internal array as a <code>String</code>. The
- * bytes in the buffer are converted to characters using the specified
- * encoding.
- *
- * @param encoding The name of the character encoding to use
- *
- * @return A <code>String</code> containing the data written to this stream so far
- *
- * @exception UnsupportedEncodingException If the named encoding is not available
- */
-public String
-toString(String encoding) throws UnsupportedEncodingException
-{
- return(new String(toByteArray(), encoding));
-}
-
-/*************************************************************************/
-
-/**
- * This method returns the bytes in the internal array as a <code>String</code>.
- * It uses each byte in the array as the low order eight bits of the Unicode
- * character value and the passed in parameter as the high eight bits.
- * <p>
- * This method does not convert bytes to characters in the proper way and
- * so is deprecated in favor of the other overloaded <code>toString</code>
- * methods which use a true character encoding.
- *
- * @param high_byte The high eight bits to use for each character in the <code>String</code>
- *
- * @return A <code>String</code> containing the data written to this stream so far
- *
- * @deprecrated
- */
-public String
-toString(int high_byte)
-{
- StringBuffer sb = new StringBuffer("");
-
- for (int i = 0; i < count; i++)
- {
- char c = (char)(((high_byte & 0xFF) << 8) | (buf[i] & 0xFF));
- sb.append(c);
- }
-
- return(sb.toString());
-}
-
-/*************************************************************************/
-
-/**
- * This method writes the writes the specified byte into the internal
- * buffer.
- *
- * @param b The byte to be read passed as an int
- */
-public synchronized void
-write(int b)
-{
- if (count == buf.length)
- enlargeBuffer();
-
- buf[count] = (byte)b;
- ++count;
-}
-
-/*************************************************************************/
-
-/**
- * This method writes <code>len</code> bytes from the passed in array
- * <code>buf</code> starting at index <code>offset</code> into the
- * internal buffer.
- *
- * @param buf The byte array to write data from
- * @param offset The index into the buffer to start writing data from
- * @param len The number of bytes to write
- */
-public synchronized void
-write(byte[] buf, int offset, int len)
-{
- int i = 0;
- while (i < (len / buffer_increment_size))
- {
- enlargeBuffer();
- System.arraycopy(buf, offset + (i * buffer_increment_size), this.buf,
- count, buffer_increment_size);
-
- count += buffer_increment_size;
- ++i;
- }
-
- if ((len % buffer_increment_size) != 0)
- {
- if ((buf.length - count) < (len % buffer_increment_size))
- enlargeBuffer();
-
- System.arraycopy(buf, offset + (i * buffer_increment_size), this.buf,
- count, len % buffer_increment_size);
-
- count += (len % buffer_increment_size);
- }
-}
-
-/*************************************************************************/
-
-/**
- * This method writes all the bytes that have been written to this stream
- * from the internal buffer to the specified <code>OutputStream</code>.
- *
- * @param out The <code>OutputStream</code> to write to
- *
- * @exception IOException If an error occurs
- */
-public void
-writeTo(OutputStream out) throws IOException
-{
- out.write(buf, 0, count);
-}
-
-/*************************************************************************/
-
-/**
- * This private method makes the buffer bigger when we run out of room
- * by allocating a larger buffer and copying the valid bytes from the
- * old array into it. This is obviously slow and should be avoided by
- * application programmers by setting their initial buffer size big
- * enough to hold everything if possible.
- */
-private void
-enlargeBuffer()
-{
- byte[] newbuf = new byte[buf.length + buffer_increment_size];
-
- System.arraycopy(buf, 0, newbuf, 0, count);
-
- buf = newbuf;
+ /**
+ * This method initializes a new <code>ByteArrayOutputStream</code>
+ * with the default buffer size of 32 bytes. If a different initial
+ * buffer size is desired, see the constructor
+ * <code>ByteArrayOutputStream(int size)</code>. For applications
+ * where the source code is not available, the default buffer size
+ * can be set using the system property
+ * <code>gnu.java.io.ByteArrayOutputStream.initialBufferSize</code>
+ */
+ public ByteArrayOutputStream ()
+ {
+ this (initial_buffer_size);
+ }
+
+ /**
+ * This method initializes a new <code>ByteArrayOutputStream</code> with
+ * a specified initial buffer size.
+ *
+ * @param size The initial buffer size in bytes
+ */
+ public ByteArrayOutputStream (int size)
+ {
+ buf = new byte[size];
+ count = 0;
+ }
+
+ /**
+ * This method discards all of the bytes that have been written to
+ * the internal buffer so far by setting the <code>count</code>
+ * variable to 0. The internal buffer remains at its currently
+ * allocated size.
+ */
+ public synchronized void reset ()
+ {
+ count = 0;
+ }
+
+ /**
+ * This method returns the number of bytes that have been written to
+ * the buffer so far. This is the same as the value of the protected
+ * <code>count</code> variable. If the <code>reset</code> method is
+ * called, then this value is reset as well. Note that this method does
+ * not return the length of the internal buffer, but only the number
+ * of bytes that have been written to it.
+ *
+ * @return The number of bytes in the internal buffer
+ *
+ * @see reset
+ */
+ public int size ()
+ {
+ return count;
+ }
+
+ /**
+ * This method returns a byte array containing the bytes that have been
+ * written to this stream so far. This array is a copy of the valid
+ * bytes in the internal buffer and its length is equal to the number of
+ * valid bytes, not necessarily to the the length of the current
+ * internal buffer. Note that since this method allocates a new array,
+ * it should be used with caution when the internal buffer is very large.
+ */
+ public synchronized byte[] toByteArray ()
+ {
+ byte[] ret = new byte[count];
+ System.arraycopy(buf, 0, ret, 0, count);
+ return ret;
+ }
+
+ /**
+ * Returns the bytes in the internal array as a <code>String</code>. The
+ * bytes in the buffer are converted to characters using the system default
+ * encoding. There is an overloaded <code>toString()</code> method that
+ * allows an application specified character encoding to be used.
+ *
+ * @return A <code>String</code> containing the data written to this
+ * stream so far
+ */
+ public String toString ()
+ {
+ return new String (buf, 0, count);
+ }
+
+ /**
+ * Returns the bytes in the internal array as a <code>String</code>. The
+ * bytes in the buffer are converted to characters using the specified
+ * encoding.
+ *
+ * @param enc The name of the character encoding to use
+ *
+ * @return A <code>String</code> containing the data written to this
+ * stream so far
+ *
+ * @exception UnsupportedEncodingException If the named encoding is
+ * not available
+ */
+ public String toString (String enc) throws UnsupportedEncodingException
+ {
+ return new String (buf, 0, count, enc);
+ }
+
+ /**
+ * This method returns the bytes in the internal array as a
+ * <code>String</code>. It uses each byte in the array as the low
+ * order eight bits of the Unicode character value and the passed in
+ * parameter as the high eight bits.
+ * <p>
+ * This method does not convert bytes to characters in the proper way and
+ * so is deprecated in favor of the other overloaded <code>toString</code>
+ * methods which use a true character encoding.
+ *
+ * @param hibyte The high eight bits to use for each character in
+ * the <code>String</code>
+ *
+ * @return A <code>String</code> containing the data written to this
+ * stream so far
+ *
+ * @deprecrated
+ */
+ public String toString (int hibyte)
+ {
+ return new String (buf, 0, count, hibyte);
+ }
+
+ // Resize buffer to accomodate new bytes.
+ private void resize (int add)
+ {
+ if (count + add >= buf.length)
+ {
+ int newlen = buf.length * 2;
+ if (count + add > newlen)
+ newlen = count + add;
+ byte[] newbuf = new byte[newlen];
+ System.arraycopy(buf, 0, newbuf, 0, count);
+ buf = newbuf;
+ }
+ }
+
+ /**
+ * This method writes the writes the specified byte into the internal
+ * buffer.
+ *
+ * @param oneByte The byte to be read passed as an int
+ */
+ public synchronized void write (int oneByte)
+ {
+ resize (1);
+ buf[count++] = (byte) oneByte;
+ }
+
+ /**
+ * This method writes <code>len</code> bytes from the passed in array
+ * <code>buf</code> starting at index <code>offset</code> into the
+ * internal buffer.
+ *
+ * @param buffer The byte array to write data from
+ * @param offset The index into the buffer to start writing data from
+ * @param add The number of bytes to write
+ */
+ public synchronized void write (byte[] buffer, int offset, int add)
+ {
+ // If ADD < 0 then arraycopy will throw the appropriate error for
+ // us.
+ if (add >= 0)
+ resize (add);
+ System.arraycopy(buffer, offset, buf, count, add);
+ count += add;
+ }
+
+ /**
+ * This method writes all the bytes that have been written to this stream
+ * from the internal buffer to the specified <code>OutputStream</code>.
+ *
+ * @param out The <code>OutputStream</code> to write to
+ *
+ * @exception IOException If an error occurs
+ */
+ public synchronized void writeTo (OutputStream out) throws IOException
+ {
+ out.write(buf, 0, count);
+ }
+
+ /**
+ * The internal buffer where the data written is stored
+ */
+ protected byte[] buf;
+
+ /**
+ * The number of bytes that have been written to the buffer
+ */
+ protected int count;
+
+ /**
+ * The default initial buffer size. Specified by the JCL.
+ */
+ private static final int DEFAULT_INITIAL_BUFFER_SIZE = 32;
+
+ // The default buffer size which can be overridden by the user.
+ private static final int initial_buffer_size;
+
+ static
+ {
+ initial_buffer_size
+ = Integer.getInteger ("gnu.java.io.ByteArrayOutputStream.initialBufferSize",
+ DEFAULT_INITIAL_BUFFER_SIZE).intValue ();
+ if (initial_buffer_size <= 0)
+ initial_buffer_size = DEFAULT_INITIAL_BUFFER_SIZE;
+ }
}
-
-} // class ByteArrayOutputStream
-