javax.servlet

Class ServletResponseWrapper

Implemented Interfaces:
ServletResponse
Known Direct Subclasses:
HttpServletResponseWrapper

public class ServletResponseWrapper
extends java.lang.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:
v 2.3
See Also:
ServletResponse

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 Details

ServletResponseWrapper

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

Method Details

flushBuffer

public void flushBuffer()
            throws IOException
The default behavior of this method is to call flushBuffer() on the wrapped response object.
Specified by:
flushBuffer in interface ServletResponse

getBufferSize

public int getBufferSize()
The default behavior of this method is to return getBufferSize() on the wrapped response object.
Specified by:
getBufferSize in interface ServletResponse

getCharacterEncoding

public String getCharacterEncoding()
The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
Specified by:
getCharacterEncoding in interface ServletResponse

getContentType

public String getContentType()
The default behavior of this method is to return getContentType() on the wrapped response object.
Specified by:
getContentType in interface ServletResponse
Since:
2.4

getLocale

public Locale getLocale()
The default behavior of this method is to return getLocale() on the wrapped response object.
Specified by:
getLocale in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
            throws IOException
The default behavior of this method is to return getOutputStream() on the wrapped response object.
Specified by:
getOutputStream in interface ServletResponse

getResponse

public ServletResponse getResponse()
Return the wrapped ServletResponse object.

getWriter

public PrintWriter getWriter()
            throws IOException
The default behavior of this method is to return getWriter() on the wrapped response object.
Specified by:
getWriter in interface ServletResponse

isCommitted

public boolean isCommitted()
The default behavior of this method is to return isCommitted() on the wrapped response object.
Specified by:
isCommitted in interface ServletResponse

reset

public void reset()
The default behavior of this method is to call reset() on the wrapped response object.
Specified by:
reset in interface ServletResponse

resetBuffer

public void resetBuffer()
The default behavior of this method is to call resetBuffer() on the wrapped response object.
Specified by:
resetBuffer in interface ServletResponse

setBufferSize

public void setBufferSize(int size)
The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
Specified by:
setBufferSize in interface ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String charset)
The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
Specified by:
setCharacterEncoding in interface ServletResponse
Since:
2.4

setContentLength

public void setContentLength(int len)
The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
Specified by:
setContentLength in interface ServletResponse

setContentType

public void setContentType(String type)
The default behavior of this method is to call setContentType(String type) on the wrapped response object.
Specified by:
setContentType in interface ServletResponse

setLocale

public void setLocale(Locale loc)
The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
Specified by:
setLocale in interface ServletResponse

setResponse

public void setResponse(ServletResponse response)
Sets the response being wrapped.