org.apache.velocity.io
Class VelocityWriter
Writer
org.apache.velocity.io.VelocityWriter
public final class VelocityWriter
extends Writer
Implementation of a fast Writer. It was originally taken from JspWriter
and modified to have less syncronization going on.
Version:
- Jason van Zyl
- Jon S. Stevens
- Anil K. Vijendran
VelocityWriter(Writer writer) - Create a buffered character-output stream that uses a default-sized
output buffer.
|
VelocityWriter(Writer writer, int sz, boolean autoFlush) - Create a new buffered character-output stream that uses an output
buffer of the given size.
|
VelocityWriter(int bufferSize, boolean autoFlush) - private constructor.
|
private void | bufferOverflow()
|
void | clear() - Discard the output buffer.
|
void | close() - Close the stream.
|
void | flush() - Flush the stream.
|
private void | flushBuffer() - Flush the output buffer to the underlying character stream, without
flushing the stream itself.
|
int | getBufferSize() - This method returns the size of the buffer used by the JspWriter.
|
int | getRemaining()
|
private void | init(Writer writer, int sz, boolean autoFlush)
|
boolean | isAutoFlush() - This method indicates whether the JspWriter is autoFlushing.
|
private int | min(int a, int b) - Our own little min method, to avoid loading
java.lang.Math if we've run out of file
descriptors and we're trying to print a stack trace.
|
void | recycle(Writer writer) - resets this class so that it can be reused
|
void | write(String s) - Write a string.
|
void | write(String s, int off, int len) - Write a portion of a String.
|
void | write(buf[] ) - Write an array of characters.
|
void | write(cbuf[] , int off, int len) - Write a portion of an array of characters.
|
void | write(int c) - Write a single character.
|
DEFAULT_BUFFER
public static final int DEFAULT_BUFFER
constant indicating that the Writer is buffered and is using the
implementation default buffer size
- -1
NO_BUFFER
public static final int NO_BUFFER
constant indicating that the Writer is not buffering output
- 0
UNBOUNDED_BUFFER
public static final int UNBOUNDED_BUFFER
constant indicating that the Writer is buffered and is unbounded;
this is used in BodyContent
- -2
autoFlush
protected boolean autoFlush
bufferSize
protected int bufferSize
defaultCharBufferSize
private static int defaultCharBufferSize
flushed
private boolean flushed
nextChar
private int nextChar
writer
private Writer writer
VelocityWriter
public VelocityWriter(Writer writer)
Create a buffered character-output stream that uses a default-sized
output buffer.
VelocityWriter
public VelocityWriter(Writer writer,
int sz,
boolean autoFlush)
Create a new buffered character-output stream that uses an output
buffer of the given size.
sz
- Output-buffer size, a positive integer
VelocityWriter
private VelocityWriter(int bufferSize,
boolean autoFlush)
private constructor.
bufferOverflow
private final void bufferOverflow()
throws IOException
clear
public final void clear()
Discard the output buffer.
close
public final void close()
throws IOException
Close the stream.
flush
public final void flush()
throws IOException
Flush the stream.
flushBuffer
private final void flushBuffer()
throws IOException
Flush the output buffer to the underlying character stream, without
flushing the stream itself. This method is non-private only so that it
may be invoked by PrintStream.
getBufferSize
public int getBufferSize()
This method returns the size of the buffer used by the JspWriter.
- the size of the buffer in bytes, or 0 is unbuffered.
getRemaining
public final int getRemaining()
- the number of bytes unused in the buffer
init
private final void init(Writer writer,
int sz,
boolean autoFlush)
isAutoFlush
public boolean isAutoFlush()
This method indicates whether the JspWriter is autoFlushing.
- if this JspWriter is auto flushing or throwing IOExceptions on
buffer overflow conditions
min
private final int min(int a,
int b)
Our own little min method, to avoid loading
java.lang.Math
if we've run out of file
descriptors and we're trying to print a stack trace.
recycle
public final void recycle(Writer writer)
resets this class so that it can be reused
write
public final void write(String s)
throws IOException
Write a string. This method cannot be inherited from the Writer class
because it must suppress I/O exceptions.
write
public final void write(String s,
int off,
int len)
throws IOException
Write a portion of a String.
s
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written
write
public final void write(buf[] )
throws IOException
Write an array of characters. This method cannot be inherited from the
Writer class because it must suppress I/O exceptions.
write
public final void write(cbuf[] ,
int off,
int len)
throws IOException
Write a portion of an array of characters.
Ordinarily this method stores characters from the given array into
this stream's buffer, flushing the buffer to the underlying stream as
needed. If the requested length is at least as large as the buffer,
however, then this method will flush the buffer and write the characters
directly to the underlying stream. Thus redundant
DiscardableBufferedWriter
s will not copy data unnecessarily.
off
- Offset from which to start reading characterslen
- Number of characters to write
write
public final void write(int c)
throws IOException
Write a single character.
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.