javax.servlet

Class ServletResponseWrapper

public class ServletResponseWrapper extends Object implements ServletResponse

Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.

Since: Servlet 2.3

Version: $Revision: 1.4 $ $Date: 2004/09/23 08:05:18 $

See Also:

Constructor Summary
	ServletResponseWrapper(ServletResponse response) Creates a ServletResponse adaptor wrapping the given response object.

Method Summary
void	flushBuffer() The default behavior of this method is to call flushBuffer() on the wrapped response object.
int	getBufferSize() The default behavior of this method is to return getBufferSize() on the wrapped response object.
String	getCharacterEncoding() The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
String	getContentType() The default behavior of this method is to return getContentType() on the wrapped response object.
Locale	getLocale() The default behavior of this method is to return getLocale() on the wrapped response object.
ServletOutputStream	getOutputStream() The default behavior of this method is to return getOutputStream() on the wrapped response object.
ServletResponse	getResponse() Return the wrapped ServletResponse object.
PrintWriter	getWriter() The default behavior of this method is to return getWriter() on the wrapped response object.
boolean	isCommitted() The default behavior of this method is to return isCommitted() on the wrapped response object.
void	reset() The default behavior of this method is to call reset() on the wrapped response object.
void	resetBuffer() The default behavior of this method is to call resetBuffer() on the wrapped response object.
void	setBufferSize(int size) The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
void	setCharacterEncoding(String charset) The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
void	setContentLength(int len) The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
void	setContentType(String type) The default behavior of this method is to call setContentType(String type) on the wrapped response object.
void	setLocale(Locale loc) The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
void	setResponse(ServletResponse response) Sets the response being wrapped.

Constructor Detail

ServletResponseWrapper

public ServletResponseWrapper(ServletResponse response)

Creates a ServletResponse adaptor wrapping the given response object.

Throws: java.lang.IllegalArgumentException if the response is null.

Method Detail

flushBuffer

public void flushBuffer()

The default behavior of this method is to call flushBuffer() on the wrapped response object.

getBufferSize

public int getBufferSize()

The default behavior of this method is to return getBufferSize() on the wrapped response object.

getCharacterEncoding

public String getCharacterEncoding()

The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.

getContentType

public String getContentType()

The default behavior of this method is to return getContentType() on the wrapped response object.

Since: Servlet 2.4

getLocale

public Locale getLocale()

The default behavior of this method is to return getLocale() on the wrapped response object.

getOutputStream

public ServletOutputStream getOutputStream()

The default behavior of this method is to return getOutputStream() on the wrapped response object.

getResponse

public ServletResponse getResponse()

Return the wrapped ServletResponse object.

getWriter

public PrintWriter getWriter()

The default behavior of this method is to return getWriter() on the wrapped response object.

isCommitted

public boolean isCommitted()

The default behavior of this method is to return isCommitted() on the wrapped response object.

reset

public void reset()

The default behavior of this method is to call reset() on the wrapped response object.

resetBuffer

public void resetBuffer()

The default behavior of this method is to call resetBuffer() on the wrapped response object.

setBufferSize

public void setBufferSize(int size)

The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.

setCharacterEncoding

public void setCharacterEncoding(String charset)

The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.

Since: Servlet 2.4

Throws: java.lang.IllegalArgumentException if the response is null.