Package org.apache.velocity.io
Class VelocityWriter
java.lang.Object
java.io.Writer
org.apache.velocity.io.VelocityWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
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
FieldsModifier and TypeFieldDescriptionprivate boolean
private int
private char[]
static final int
constant indicating that the Writer is buffered and is using the implementation default buffer sizeprivate static int
private int
static final int
constant indicating that the Writer is not buffering outputstatic final int
constant indicating that the Writer is buffered and is unbounded; this is used in BodyContentprivate Writer
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
VelocityWriter
(int bufferSize, boolean autoFlush) private constructor.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. -
Method Summary
Modifier and TypeMethodDescriptionprivate final void
final void
clear()
Discard the output buffer.final void
close()
Close the stream.final void
flush()
Flush the stream.private final void
Flush the output buffer to the underlying character stream, without flushing the stream itself.int
This method returns the size of the buffer used by the JspWriter.final int
boolean
This method indicates whether the JspWriter is autoFlushing.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.final void
resets this class so that it can be reusedfinal void
write
(char[] buf) Write an array of characters.final void
write
(char[] cbuf, int off, int len) Write a portion of an array of characters.final void
write
(int c) Write a single character.final void
Write a string.final void
Write a portion of a String.Methods inherited from class java.io.Writer
append, append, append, nullWriter
-
Field Details
-
NO_BUFFER
public static final int NO_BUFFERconstant indicating that the Writer is not buffering output- See Also:
-
DEFAULT_BUFFER
public static final int DEFAULT_BUFFERconstant indicating that the Writer is buffered and is using the implementation default buffer size- See Also:
-
UNBOUNDED_BUFFER
public static final int UNBOUNDED_BUFFERconstant indicating that the Writer is buffered and is unbounded; this is used in BodyContent- See Also:
-
bufferSize
private int bufferSize -
autoFlush
private boolean autoFlush -
writer
-
cb
private char[] cb -
nextChar
private int nextChar -
defaultCharBufferSize
private static int defaultCharBufferSize
-
-
Constructor Details
-
VelocityWriter
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
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:
IllegalArgumentException
- If sz is <= 0
-
-
Method Details
-
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
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:
IOException
-
clear
public final void clear()Discard the output buffer. -
bufferOverflow
- Throws:
IOException
-
flush
Flush the stream.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classWriter
- Throws:
IOException
-
close
Close the stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
-
getRemaining
public final int getRemaining()- Returns:
- the number of bytes unused in the buffer
-
write
Write a single character.- Overrides:
write
in classWriter
- Parameters:
c
-- Throws:
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
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 classWriter
- Parameters:
cbuf
- A character arrayoff
- Offset from which to start reading characterslen
- Number of characters to write- Throws:
IOException
-
write
Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classWriter
- Parameters:
buf
-- Throws:
IOException
-
write
Write a portion of a String.- Overrides:
write
in classWriter
- Parameters:
s
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
IOException
-
write
Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classWriter
- Parameters:
s
-- Throws:
IOException
-
recycle
resets this class so that it can be reused- Parameters:
writer
-
-