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:
java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
public class JspWriterImpl extends 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 Classes Modifier and Type Class Description private static class
JspWriterImpl.CharBuffer
private static class
JspWriterImpl.CharBufferThreadLocalPool
-
Field Summary
Fields Modifier and Type Field Description private JspWriterImpl.CharBuffer
buf
protected ByteWriter
byteOut
private static java.lang.ThreadLocal<JspWriterImpl.CharBufferThreadLocalPool>
charBufferPools
private boolean
closed
private boolean
flushed
protected boolean
implementsByteWriter
(package private) static java.lang.String
lineSeparator
private static int
MAX_BUFFER_SIZE
private java.io.Writer
out
private javax.servlet.ServletResponse
response
-
Fields inherited from class javax.servlet.jsp.JspWriter
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
-
-
Constructor Summary
Constructors Constructor Description JspWriterImpl()
JspWriterImpl(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
allocateCharBuffer()
private void
bufferOverflow()
void
clear()
Discard the output buffer.void
clearBuffer()
Clears the current contents of the buffer.void
close()
Close the stream.private void
ensureOpen()
check to make sure that the stream has not been closedvoid
flush()
Flush the stream.protected void
flushBuffer()
Flush the output buffer to the underlying character stream, without flushing the stream itself.private JspWriterImpl.CharBufferThreadLocalPool
getCharBufferThreadLocalPool()
private java.lang.String
getLocalizeMessage(java.lang.String message)
int
getRemaining()
This method returns the number of unused bytes in the buffer.boolean
hasData()
(package private) void
init(javax.servlet.ServletResponse response, int sz, boolean autoFlush)
private void
initByteOut()
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(java.lang.Object obj)
Print an object.void
print(java.lang.String s)
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
println(java.lang.Object x)
Print an Object and then terminate the line.void
println(java.lang.String x)
Print a String and then terminate the line.(package private) void
recycle()
Package-level accessprivate void
releaseCharBuffer()
(package private) boolean
shouldOutputBytes()
void
write(boolean bytesOK, byte[] buf, java.lang.String str)
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(java.lang.String s)
Write a string.void
write(java.lang.String s, int off, int len)
Write a portion of a String.-
Methods inherited from class javax.servlet.jsp.JspWriter
getBufferSize, isAutoFlush
-
-
-
-
Field Detail
-
MAX_BUFFER_SIZE
private static final int MAX_BUFFER_SIZE
-
charBufferPools
private static final java.lang.ThreadLocal<JspWriterImpl.CharBufferThreadLocalPool> charBufferPools
-
out
private java.io.Writer out
-
response
private javax.servlet.ServletResponse response
-
buf
private JspWriterImpl.CharBuffer buf
-
flushed
private boolean flushed
-
closed
private boolean closed
-
implementsByteWriter
protected boolean implementsByteWriter
-
byteOut
protected ByteWriter byteOut
-
lineSeparator
static java.lang.String lineSeparator
-
-
Constructor Detail
-
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:
java.lang.IllegalArgumentException
- If sz is <= 0
-
-
Method Detail
-
init
void init(javax.servlet.ServletResponse response, int sz, boolean autoFlush)
-
recycle
void recycle()
Package-level access
-
flushBuffer
protected 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
-
initOut
private void initOut() throws java.io.IOException
- Throws:
java.io.IOException
-
getLocalizeMessage
private java.lang.String getLocalizeMessage(java.lang.String message)
-
clear
public final void clear() throws java.io.IOException
Discard the output buffer.
-
clearBuffer
public void clearBuffer() throws java.io.IOException
Description copied from class:JspWriter
Clears the current contents of the buffer. Unlike clear(), this method will not throw an IOException if the buffer has already been flushed. It merely clears the current content of the buffer and returns.- Specified by:
clearBuffer
in classJspWriter
- Throws:
java.io.IOException
- If an I/O error occurs
-
bufferOverflow
private final void bufferOverflow() throws java.io.IOException
- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
Flush the stream.
-
close
public void close() throws java.io.IOException
Close the stream.
-
getRemaining
public int getRemaining()
Description copied from class:JspWriter
This method returns the number of unused bytes in the buffer.- Specified by:
getRemaining
in classJspWriter
- Returns:
- the number of bytes unused in the buffer
-
ensureOpen
private void ensureOpen() throws java.io.IOException
check to make sure that the stream has not been closed- Throws:
java.io.IOException
-
write
public void write(boolean bytesOK, byte[] buf, java.lang.String str) throws java.io.IOException
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:
java.io.IOException
-
shouldOutputBytes
boolean shouldOutputBytes()
-
initByteOut
private void initByteOut() throws java.io.IOException
- Throws:
java.io.IOException
-
write
public void write(byte[] buf, int off, int len) throws java.io.IOException
- Throws:
java.io.IOException
-
write
public void write(int c) throws java.io.IOException
Write a single character.- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.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
public 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 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
- Throws:
java.io.IOException
-
write
public 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 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
- Throws:
java.io.IOException
-
newLine
public void newLine() throws java.io.IOException
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.
-
print
public void print(boolean b) throws java.io.IOException
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)
-
print
public void print(char c) throws java.io.IOException
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)
-
print
public void print(int i) throws java.io.IOException
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)
-
print
public void print(long l) throws java.io.IOException
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)
-
print
public void print(float f) throws java.io.IOException
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)
-
print
public void print(double d) throws java.io.IOException
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)
-
print
public void print(char[] s) throws java.io.IOException
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)
-
print
public void print(java.lang.String s) throws java.io.IOException
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)
-
print
public void print(java.lang.Object obj) throws java.io.IOException
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)
-
println
public void println() throws java.io.IOException
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...
-
println
public void println(boolean x) throws java.io.IOException
Print a boolean value and then terminate the line. This method behaves as though it invokes
and thenprint(boolean)
.println()
-
println
public void println(char x) throws java.io.IOException
Print a character and then terminate the line. This method behaves as though it invokes
and thenprint(char)
.println()
-
println
public void println(int x) throws java.io.IOException
Print an integer and then terminate the line. This method behaves as though it invokes
and thenprint(int)
.println()
-
println
public void println(long x) throws java.io.IOException
Print a long integer and then terminate the line. This method behaves as though it invokes
and thenprint(long)
.println()
-
println
public void println(float x) throws java.io.IOException
Print a floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(float)
.println()
-
println
public void println(double x) throws java.io.IOException
Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(double)
.println()
-
println
public void println(char[] x) throws java.io.IOException
Print an array of characters and then terminate the line. This method behaves as though it invokes
and thenprint(char[])
.println()
-
println
public void println(java.lang.String x) throws java.io.IOException
Print a String and then terminate the line. This method behaves as though it invokes
and thenprint(String)
.println()
-
println
public void println(java.lang.Object x) throws java.io.IOException
Print an Object and then terminate the line. This method behaves as though it invokes
and thenprint(Object)
.println()
-
hasData
public boolean hasData()
-
allocateCharBuffer
private void allocateCharBuffer()
-
releaseCharBuffer
private void releaseCharBuffer()
-
getCharBufferThreadLocalPool
private JspWriterImpl.CharBufferThreadLocalPool getCharBufferThreadLocalPool()
-
-