ServletResponseWrapper (Java EE 5 SDK)

Java

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


javax.servlet Class ServletResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
所有已实现的接口:
ServletResponse
直接已知子类:
HttpServletResponseWrapper

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.

从以下版本开始:
v 2.3
作者:
Various
另请参见:
ServletResponse

构造器摘要
ServletResponseWrapper(ServletResponse response)
          Creates a ServletResponse adaptor wrapping the given response object.
 
方法摘要
 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.
 
类方法继承 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造器详细信息

ServletResponseWrapper

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

抛出异常:
IllegalArgumentException - if the response is null.

方法详细信息

getResponse

public ServletResponse getResponse()
Return the wrapped ServletResponse object.


setResponse

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

抛出异常:
IllegalArgumentException - if the response is null.

setCharacterEncoding

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

规范说明:
setCharacterEncoding in interface ServletResponse
参数:
charset - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
从以下版本开始:
2.4
另请参见:
#setLocale

getCharacterEncoding

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

规范说明:
getCharacterEncoding in interface ServletResponse
返回:
a String specifying the name of the character encoding, for example, UTF-8

getOutputStream

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

规范说明:
getOutputStream in interface ServletResponse
返回:
a ServletOutputStream for writing binary data
抛出异常:
IOException - if an input or output exception occurred
另请参见:
ServletResponse.getWriter()

getWriter

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

规范说明:
getWriter in interface ServletResponse
返回:
a PrintWriter object that can return character data to the client
抛出异常:
IOException - if an input or output exception occurred
另请参见:
ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String)

setContentLength

public void setContentLength(int len)
The default behavior of this method is to call setContentLength(int len) on the wrapped response object.

规范说明:
setContentLength in interface ServletResponse
参数:
len - an integer specifying the length of the content being returned to the client; sets the Content-Length header

setContentType

public void setContentType(String type)
The default behavior of this method is to call setContentType(String type) on the wrapped response object.

规范说明:
setContentType in interface ServletResponse
参数:
type - a String specifying the MIME type of the content
另请参见:
ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()

getContentType

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

规范说明:
getContentType in interface ServletResponse
返回:
a String specifying the content type, for example, text/html; charset=UTF-8, or null
从以下版本开始:
2.4

setBufferSize

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

规范说明:
setBufferSize in interface ServletResponse
参数:
size - the preferred buffer size
另请参见:
ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()

getBufferSize

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

规范说明:
getBufferSize in interface ServletResponse
返回:
the actual buffer size used
另请参见:
ServletResponse.setBufferSize(int), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()

flushBuffer

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

规范说明:
flushBuffer in interface ServletResponse
抛出异常:
IOException
另请参见:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()

isCommitted

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

规范说明:
isCommitted in interface ServletResponse
返回:
a boolean indicating if the response has been committed
另请参见:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.reset()

reset

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

规范说明:
reset in interface ServletResponse
另请参见:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted()

resetBuffer

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

规范说明:
resetBuffer in interface ServletResponse
另请参见:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()

setLocale

public void setLocale(Locale loc)
The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.

规范说明:
setLocale in interface ServletResponse
参数:
loc - the locale of the response
另请参见:
ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)

getLocale

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

规范说明:
getLocale in interface ServletResponse
另请参见:
ServletResponse.setLocale(java.util.Locale)

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


提交错误或意见

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.