org.zkoss.web.servlet

Class BufferedResponse

java.lang.Object

jakarta.servlet.ServletResponseWrapper

org.zkoss.web.servlet.BufferedResponse

All Implemented Interfaces:

jakarta.servlet.ServletResponse

public class BufferedResponse
extends jakarta.servlet.ServletResponseWrapper

A servlet response that uses another writer or stream as the output.

Author:

tomyeh

Method Summary

Modifier and Type	Method and Description
void	flushBuffer()
static jakarta.servlet.ServletResponse	getInstance(jakarta.servlet.ServletResponse response, OutputStream stream) Returns a buffered response with a output stream, if stream is not null; or the original response if stream is null.
static jakarta.servlet.ServletResponse	getInstance(jakarta.servlet.ServletResponse response, Writer writer) Returns a buffered response with a writer, if writer is not null; or the original response if writer is null.
jakarta.servlet.ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
void	resetBuffer() Useful only if StringWriter or ByteArrayOutputStream is used to construct this object.

Methods inherited from class jakarta.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static final jakarta.servlet.ServletResponse getInstance(jakarta.servlet.ServletResponse response,
                                                              Writer writer)

Returns a buffered response with a writer, if writer is not null; or the original response if writer is null. If response is HttpServletResponse, HttpBufferedResponse.getInstance(jakarta.servlet.http.HttpServletResponse, java.io.Writer) is returned. It is smart enough not to wrap the same writer twice.

getInstance

public static final jakarta.servlet.ServletResponse getInstance(jakarta.servlet.ServletResponse response,
                                                              OutputStream stream)

Returns a buffered response with a output stream, if stream is not null; or the original response if stream is null. If response is HttpServletResponse, HttpBufferedResponse.getInstance(jakarta.servlet.http.HttpServletResponse, java.io.Writer) is returned. It is smart enough not to wrap the same stream twice.

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Overrides:

getWriter in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Overrides:

getOutputStream in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Overrides:

flushBuffer in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

resetBuffer

public void resetBuffer()

Useful only if StringWriter or ByteArrayOutputStream is used to construct this object.

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

Overrides:

resetBuffer in class jakarta.servlet.ServletResponseWrapper