Package org.apache.velocity.io
Class VelocityWriter
- java.lang.Object
-
- java.io.Writer
-
- org.apache.velocity.io.VelocityWriter
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
public final class VelocityWriter extends java.io.Writer
Implementation of a fast Writer. It was originally taken from JspWriter and modified to have less syncronization going on.- Version:
- $Id: VelocityWriter.java 463298 2006-10-12 16:10:32Z henning $
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
autoFlush
private int
bufferSize
private char[]
cb
static int
DEFAULT_BUFFER
constant indicating that the Writer is buffered and is using the implementation default buffer sizeprivate static int
defaultCharBufferSize
private int
nextChar
static int
NO_BUFFER
constant indicating that the Writer is not buffering outputstatic int
UNBOUNDED_BUFFER
constant indicating that the Writer is buffered and is unbounded; this is used in BodyContentprivate java.io.Writer
writer
-
Constructor Summary
Constructors Modifier Constructor Description private
VelocityWriter(int bufferSize, boolean autoFlush)
private constructor.VelocityWriter(java.io.Writer writer)
Create a buffered character-output stream that uses a default-sized output buffer.VelocityWriter(java.io.Writer writer, int sz, boolean autoFlush)
Create a new buffered character-output stream that uses an output buffer of the given size.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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()
boolean
isAutoFlush()
This method indicates whether the JspWriter is autoFlushing.private int
min(int a, int b)
Our own little min method, to avoid loadingjava.lang.Math
if we've run out of file descriptors and we're trying to print a stack trace.void
recycle(java.io.Writer writer)
resets this class so that it can be reusedvoid
write(char[] buf)
Write an array of characters.void
write(char[] cbuf, int off, int len)
Write a portion of an array of characters.void
write(int c)
Write a single character.void
write(java.lang.String s)
Write a string.void
write(java.lang.String s, int off, int len)
Write a portion of a String.
-
-
-
Field Detail
-
NO_BUFFER
public static final int NO_BUFFER
constant indicating that the Writer is not buffering output- See Also:
- Constant Field Values
-
DEFAULT_BUFFER
public static final int DEFAULT_BUFFER
constant indicating that the Writer is buffered and is using the implementation default buffer size- See Also:
- Constant Field Values
-
UNBOUNDED_BUFFER
public static final int UNBOUNDED_BUFFER
constant indicating that the Writer is buffered and is unbounded; this is used in BodyContent- See Also:
- Constant Field Values
-
bufferSize
private int bufferSize
-
autoFlush
private boolean autoFlush
-
writer
private java.io.Writer writer
-
cb
private char[] cb
-
nextChar
private int nextChar
-
defaultCharBufferSize
private static int defaultCharBufferSize
-
-
Constructor Detail
-
VelocityWriter
public VelocityWriter(java.io.Writer writer)
Create a buffered character-output stream that uses a default-sized output buffer.- Parameters:
writer
- Writer to wrap around
-
VelocityWriter
private VelocityWriter(int bufferSize, boolean autoFlush)
private constructor.
-
VelocityWriter
public VelocityWriter(java.io.Writer writer, int sz, boolean autoFlush)
Create a new buffered character-output stream that uses an output buffer of the given size.- Parameters:
writer
- Writer to wrap aroundsz
- Output-buffer size, a positive integerautoFlush
-- Throws:
java.lang.IllegalArgumentException
- If sz is <= 0
-
-
Method Detail
-
getBufferSize
public int getBufferSize()
This method returns the size of the buffer used by the JspWriter.- Returns:
- the size of the buffer in bytes, or 0 is unbuffered.
-
isAutoFlush
public boolean isAutoFlush()
This method indicates whether the JspWriter is autoFlushing.- Returns:
- if this JspWriter is auto flushing or throwing IOExceptions on buffer overflow conditions
-
flushBuffer
private final void flushBuffer() throws java.io.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.- Throws:
java.io.IOException
-
clear
public final void clear()
Discard the output buffer.
-
bufferOverflow
private final void bufferOverflow() throws java.io.IOException
- Throws:
java.io.IOException
-
flush
public final void flush() throws java.io.IOException
Flush the stream.- Specified by:
flush
in interfacejava.io.Flushable
- Specified by:
flush
in classjava.io.Writer
- Throws:
java.io.IOException
-
close
public final void close() throws java.io.IOException
Close the stream.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classjava.io.Writer
- Throws:
java.io.IOException
-
getRemaining
public final int getRemaining()
- Returns:
- the number of bytes unused in the buffer
-
write
public final void write(int c) throws java.io.IOException
Write a single character.- Overrides:
write
in classjava.io.Writer
- Parameters:
c
-- Throws:
java.io.IOException
-
min
private final int min(int a, int b)
Our own little min method, to avoid loadingjava.lang.Math
if we've run out of file descriptors and we're trying to print a stack trace.
-
write
public final void write(char[] cbuf, int off, int len) throws java.io.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.- Specified by:
write
in classjava.io.Writer
- Parameters:
cbuf
- A character arrayoff
- Offset from which to start reading characterslen
- Number of characters to write- Throws:
java.io.IOException
-
write
public final void write(char[] buf) throws java.io.IOException
Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classjava.io.Writer
- Parameters:
buf
-- Throws:
java.io.IOException
-
write
public final void write(java.lang.String s, int off, int len) throws java.io.IOException
Write a portion of a String.- Overrides:
write
in classjava.io.Writer
- Parameters:
s
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
java.io.IOException
-
write
public final void write(java.lang.String s) throws java.io.IOException
Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classjava.io.Writer
- Parameters:
s
-- Throws:
java.io.IOException
-
recycle
public final void recycle(java.io.Writer writer)
resets this class so that it can be reused- Parameters:
writer
-
-
-