com.sun.faces.io.FastStringWriter Maven / Gradle / Ivy
/*
* $Id: FastStringWriter.java,v 1.1 2006/02/21 20:37:51 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.faces.io;
import java.io.IOException;
import java.io.Writer;
/**
* This is based on {@link java.io.StringWriter} but backed by a
* {@link StringBuilder} instead.
*
* This class is not thread safe.
*/
public class FastStringWriter extends Writer {
private StringBuilder builder;
// ------------------------------------------------------------ Constructors
/**
* Constructs a new FastStringWriter instance
* using the default capacity of 16.
*/
public FastStringWriter() {
builder = new StringBuilder();
}
/**
* Constructs a new FastStringWriter instance
* using the specified initialCapacity.
*
* @param initialCapacity specifies the initial capacity of the buffer
*
* @throws IllegalArgumentException if initialCapacity is less than zero
*/
public FastStringWriter(int initialCapacity) {
if (initialCapacity < 0) {
throw new IllegalArgumentException();
}
builder = new StringBuilder(initialCapacity);
}
// ----------------------------------------------------- Methods from Writer
/**
* Write a portion of an array of characters.
*
* @param cbuf Array of characters
* @param off Offset from which to start writing characters
* @param len Number of characters to write
*
* @throws IOException
*/
public void write(char cbuf[], int off, int len) throws IOException {
if ((off < 0) || (off > cbuf.length) || (len < 0) ||
((off + len) > cbuf.length) || ((off + len) < 0)) {
throw new IndexOutOfBoundsException();
} else if (len == 0) {
return;
}
builder.append(cbuf, off, len);
}
/**
* This is a no-op.
*
* @throws IOException
*/
public void flush() throws IOException {
}
/**
* This is a no-op.
*
* @throws IOException
*/
public void close() throws IOException {
}
// ---------------------------------------------------------- Public Methods
/**
* Write a string.
*
* @param str String to be written
*/
public void write(String str) {
write(str, 0, str.length());
}
/**
* Write a portion of a string.
*
* @param str A String
* @param off Offset from which to start writing characters
* @param len Number of characters to write
*/
public void write(String str, int off, int len) {
builder.append(str.substring(off, off + len));
}
/**
* Return the StringBuilder itself.
*
* @return StringBuilder holding the current buffer value.
*/
public StringBuilder getBuffer() {
return builder;
}
/** @return the buffer's current value as a string. */
public String toString() {
return builder.toString();
}
}