Package org.apache.jasper.runtime
Class JspWriterImpl
java.lang.Object
java.io.Writer
javax.servlet.jsp.JspWriter
org.apache.jasper.runtime.JspWriterImpl
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
public class JspWriterImpl
extends javax.servlet.jsp.JspWriter
Write text to a character-output stream, buffering characters so as
to provide for the efficient writing of single characters, arrays,
and strings.
Provide support for discarding for the output that has been
buffered.
This needs revisiting when the buffering problems in the JSP spec
are fixed -akv What buffering problems? -kmc
Add method for writing bytes. This allows static texts to be pre-encoded,
for performance. Note that this can be done only if the page is unbuffered.
-kmc
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate JspWriterImpl.CharBuffer
protected ByteWriter
private static final ThreadLocal
<JspWriterImpl.CharBufferThreadLocalPool> private boolean
private boolean
protected boolean
(package private) static String
private static final int
private Writer
private javax.servlet.ServletResponse
Fields inherited from class javax.servlet.jsp.JspWriter
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
-
Constructor Summary
ConstructorsConstructorDescriptionJspWriterImpl
(javax.servlet.ServletResponse response) Create a buffered character-output stream that uses a default-sized output buffer.JspWriterImpl
(javax.servlet.ServletResponse response, 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 void
private final void
final void
clear()
Discard the output buffer.void
void
close()
Close the stream.private void
check to make sure that the stream has not been closedvoid
flush()
Flush the stream.protected final void
Flush the output buffer to the underlying character stream, without flushing the stream itself.private String
getLocalizeMessage
(String message) int
boolean
hasData()
(package private) void
init
(javax.servlet.ServletResponse response, int sz, boolean autoFlush) private void
private void
initOut()
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
newLine()
Write a line separator.void
print
(boolean b) Print a boolean value.void
print
(char c) Print a character.void
print
(char[] s) Print an array of characters.void
print
(double d) Print a double-precision floating-point number.void
print
(float f) Print a floating-point number.void
print
(int i) Print an integer.void
print
(long l) Print a long integer.void
Print an object.void
Print a string.void
println()
Terminate the current line by writing the line separator string.void
println
(boolean x) Print a boolean value and then terminate the line.void
println
(char x) Print a character and then terminate the line.void
println
(char[] x) Print an array of characters and then terminate the line.void
println
(double x) Print a double-precision floating-point number and then terminate the line.void
println
(float x) Print a floating-point number and then terminate the line.void
println
(int x) Print an integer and then terminate the line.void
println
(long x) Print a long integer and then terminate the line.void
Print an Object and then terminate the line.void
Print a String and then terminate the line.(package private) void
recycle()
Package-level accessprivate void
(package private) boolean
void
Attempt to write a String pre-encoded with the page encoding.void
write
(byte[] buf, int off, int len) void
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 a string.void
Write a portion of a String.Methods inherited from class javax.servlet.jsp.JspWriter
getBufferSize, isAutoFlush
Methods inherited from class java.io.Writer
append, append, append, nullWriter
-
Field Details
-
MAX_BUFFER_SIZE
private static final int MAX_BUFFER_SIZE -
charBufferPools
-
out
-
response
private javax.servlet.ServletResponse response -
buf
-
flushed
private boolean flushed -
closed
private boolean closed -
implementsByteWriter
protected boolean implementsByteWriter -
byteOut
-
lineSeparator
-
-
Constructor Details
-
JspWriterImpl
public JspWriterImpl() -
JspWriterImpl
public JspWriterImpl(javax.servlet.ServletResponse response) Create a buffered character-output stream that uses a default-sized output buffer.- Parameters:
response
- A Servlet Response
-
JspWriterImpl
public JspWriterImpl(javax.servlet.ServletResponse response, int sz, boolean autoFlush) Create a new buffered character-output stream that uses an output buffer of the given size.- Parameters:
response
- A Servlet Responsesz
- Output-buffer size, a positive integer- Throws:
IllegalArgumentException
- If sz is invalid input: '<'= 0
-
-
Method Details
-
init
void init(javax.servlet.ServletResponse response, int sz, boolean autoFlush) -
recycle
void recycle()Package-level access -
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
-
initOut
- Throws:
IOException
-
getLocalizeMessage
-
clear
Discard the output buffer.- Specified by:
clear
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
clearBuffer
- Specified by:
clearBuffer
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
bufferOverflow
- Throws:
IOException
-
flush
Flush the stream.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
close
Close the stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
getRemaining
public int getRemaining()- Specified by:
getRemaining
in classjavax.servlet.jsp.JspWriter
- Returns:
- the number of bytes unused in the buffer
-
ensureOpen
check to make sure that the stream has not been closed- Throws:
IOException
-
write
Attempt to write a String pre-encoded with the page encoding.- Parameters:
bytesOK
- If true, write out the byte array, else, write out the String.buf
- The text encoded with the page encodingstr
- The original text- Throws:
IOException
-
shouldOutputBytes
boolean shouldOutputBytes() -
initByteOut
- Throws:
IOException
-
write
- Throws:
IOException
-
write
Write a single character.- Overrides:
write
in classWriter
- Throws:
IOException
-
min
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. -
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
- 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
- Throws:
IOException
-
newLine
Write a line separator. The line separator string is defined by the system property line.separator, and is not necessarily a single newline ('\n') character.- Specified by:
newLine
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
- If an I/O error occurs
-
print
Print a boolean value. The string produced by
is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(boolean)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
b
- Theboolean
to be printed- Throws:
IOException
-
print
Print a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
c
- Thechar
to be printed- Throws:
IOException
-
print
Print an integer. The string produced by
is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(int)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
i
- Theint
to be printed- Throws:
IOException
-
print
Print a long integer. The string produced by
is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(long)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
l
- Thelong
to be printed- Throws:
IOException
-
print
Print a floating-point number. The string produced by
is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(float)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
f
- Thefloat
to be printed- Throws:
IOException
-
print
Print a double-precision floating-point number. The string produced by
is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(double)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
d
- Thedouble
to be printed- Throws:
IOException
-
print
Print an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
s
- The array of chars to be printed- Throws:
NullPointerException
- Ifs
isnull
IOException
-
print
Print a string. If the argument isnull
then the string"null"
is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
s
- TheString
to be printed- Throws:
IOException
-
print
Print an object. The string produced by the
method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(Object)
method.write(int)
- Specified by:
print
in classjavax.servlet.jsp.JspWriter
- Parameters:
obj
- TheObject
to be printed- Throws:
IOException
-
println
Terminate the current line by writing the line separator string. The line separator string is defined by the system propertyline.separator
, and is not necessarily a single newline character ('\n'
). Need to change this from PrintWriter because the default println() writes to the sink directly instead of through the write method...- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a boolean value and then terminate the line. This method behaves as though it invokes
and thenprint(boolean)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a character and then terminate the line. This method behaves as though it invokes
and thenprint(char)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print an integer and then terminate the line. This method behaves as though it invokes
and thenprint(int)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a long integer and then terminate the line. This method behaves as though it invokes
and thenprint(long)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(float)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(double)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print an array of characters and then terminate the line. This method behaves as though it invokes
and thenprint(char[])
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print a String and then terminate the line. This method behaves as though it invokes
and thenprint(String)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
println
Print an Object and then terminate the line. This method behaves as though it invokes
and thenprint(Object)
.println()
- Specified by:
println
in classjavax.servlet.jsp.JspWriter
- Throws:
IOException
-
hasData
public boolean hasData() -
allocateCharBuffer
private void allocateCharBuffer() -
releaseCharBuffer
private void releaseCharBuffer() -
getCharBufferThreadLocalPool
-