source: trunk/src/gcc/libjava/java/io/CharArrayWriter.java@ 192

Last change on this file since 192 was 2, checked in by bird, 23 years ago

Initial revision

  • Property cvs2svn:cvs-rev set to 1.1
  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 8.7 KB
Line 
1/* CharArrayWriter.java -- Write chars to a buffer
2 Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
3
4This file is part of GNU Classpath.
5
6GNU Classpath is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 2, or (at your option)
9any later version.
10
11GNU Classpath is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Classpath; see the file COPYING. If not, write to the
18Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
1902111-1307 USA.
20
21Linking this library statically or dynamically with other modules is
22making a combined work based on this library. Thus, the terms and
23conditions of the GNU General Public License cover the whole
24combination.
25
26As a special exception, the copyright holders of this library give you
27permission to link this library with independent modules to produce an
28executable, regardless of the license terms of these independent
29modules, and to copy and distribute the resulting executable under
30terms of your choice, provided that you also meet, for each linked
31independent module, the terms and conditions of the license of that
32module. An independent module is a module which is not derived from
33or based on this library. If you modify this library, you may extend
34this exception to your version of the library, but you are not
35obligated to do so. If you do not wish to do so, delete this
36exception statement from your version. */
37
38
39package java.io;
40
41/**
42 * This class allows data to be written to a char array buffer and
43 * and then retrieved by an application. The internal char array
44 * buffer is dynamically resized to hold all the data written. Please
45 * be aware that writing large amounts to data to this stream will
46 * cause large amounts of memory to be allocated.
47 * <p>
48 * The size of the internal buffer defaults to 32 and it is resized
49 * in increments of 1024 chars. This behavior can be over-ridden by using the
50 * following two properties:
51 * <p>
52 * <ul>
53 * <li><xmp>gnu.java.io.CharArrayWriter.initialBufferSize</xmp>
54 * <li><xmp>gnu.java.io.CharArrayWriter.bufferIncrementSize</xmp>
55 * </ul>
56 * <p>
57 * There is a constructor that specified the initial buffer size and
58 * that is the preferred way to set that value because it it portable
59 * across all Java class library implementations.
60 * <p>
61 *
62 * @author Aaron M. Renn ([email protected])
63 * @author Tom Tromey <[email protected]>
64 */
65public class CharArrayWriter extends Writer
66{
67 /**
68 * The default initial buffer size
69 */
70 private static final int DEFAULT_INITIAL_BUFFER_SIZE = 32;
71
72 /**
73 * This method initializes a new <code>CharArrayWriter</code> with
74 * the default buffer size of 32 chars. If a different initial
75 * buffer size is desired, see the constructor
76 * <code>CharArrayWriter(int size)</code>.
77 */
78 public CharArrayWriter ()
79 {
80 this (DEFAULT_INITIAL_BUFFER_SIZE);
81 }
82
83 /**
84 * This method initializes a new <code>CharArrayWriter</code> with
85 * a specified initial buffer size.
86 *
87 * @param size The initial buffer size in chars
88 */
89 public CharArrayWriter (int size)
90 {
91 super ();
92 buf = new char[size];
93 }
94
95 /**
96 * Closes the stream. This method is guaranteed not to free the contents
97 * of the internal buffer, which can still be retrieved.
98 */
99 public void close ()
100 {
101 closed = true;