001: /*
002: * @(#)StringWriter.java 1.25 06/10/10
003: *
004: * Copyright 1990-2006 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: *
026: */
027:
028: package java.io;
029:
030: /**
031: * A character stream that collects its output in a string buffer, which can
032: * then be used to construct a string.
033: * <p>
034: * Closing a <tt>StringWriter</tt> has no effect. The methods in this class
035: * can be called after the stream has been closed without generating an
036: * <tt>IOException</tt>.
037: *
038: * @version 1.18, 00/02/02
039: * @author Mark Reinhold
040: * @since JDK1.1
041: */
042:
043: public class StringWriter extends Writer {
044:
045: private StringBuffer buf;
046:
047: /**
048: * Create a new string writer, using the default initial string-buffer
049: * size.
050: */
051: public StringWriter() {
052: buf = new StringBuffer();
053: lock = buf;
054: }
055:
056: /**
057: * Create a new string writer, using the specified initial string-buffer
058: * size.
059: *
060: * @param initialSize an int specifying the initial size of the buffer.
061: */
062: public StringWriter(int initialSize) {
063: if (initialSize < 0) {
064: throw new IllegalArgumentException("Negative buffer size");
065: }
066: buf = new StringBuffer(initialSize);
067: lock = buf;
068: }
069:
070: /**
071: * Write a single character.
072: */
073: public void write(int c) {
074: buf.append((char) c);
075: }
076:
077: /**
078: * Write a portion of an array of characters.
079: *
080: * @param cbuf Array of characters
081: * @param off Offset from which to start writing characters
082: * @param len Number of characters to write
083: */
084: public void write(char cbuf[], int off, int len) {
085: if ((off < 0) || (off > cbuf.length) || (len < 0)
086: || ((off + len) > cbuf.length) || ((off + len) < 0)) {
087: throw new IndexOutOfBoundsException();
088: } else if (len == 0) {
089: return;
090: }
091: buf.append(cbuf, off, len);
092: }
093:
094: /**
095: * Write a string.
096: */
097: public void write(String str) {
098: buf.append(str);
099: }
100:
101: /**
102: * Write a portion of a string.
103: *
104: * @param str String to be written
105: * @param off Offset from which to start writing characters
106: * @param len Number of characters to write
107: */
108: public void write(String str, int off, int len) {
109: buf.append(str.substring(off, off + len));
110: }
111:
112: /**
113: * Return the buffer's current value as a string.
114: */
115: public String toString() {
116: return buf.toString();
117: }
118:
119: /**
120: * Return the string buffer itself.
121: *
122: * @return StringBuffer holding the current buffer value.
123: */
124: public StringBuffer getBuffer() {
125: return buf;
126: }
127:
128: /**
129: * Flush the stream.
130: */
131: public void flush() {
132: }
133:
134: /**
135: * Closing a <tt>StringWriter</tt> has no effect. The methods in this
136: * class can be called after the stream has been closed without generating
137: * an <tt>IOException</tt>.
138: */
139: public void close() throws IOException {
140: }
141:
142: }
|