Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.servlet
Class ServletResponseWrapper

    java.lang.Object
      |
      +--javax.servlet.ServletResponseWrapper

Direct Known 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
Version:
  $Version$
Author:
  Various
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.
`java.lang.String` | `getCharacterEncoding()` The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
`java.util.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.
`java.io.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` | `setContentLength(int len)` The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
`void` | `setContentType(java.lang.String type)` The default behavior of this method is to call setContentType(String type) on the wrapped response object.
`void` | `setLocale(java.util.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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

### getResponse

    public ServletResponse getResponse()

  Return the wrapped ServletResponse object.

### setResponse

    public void setResponse(ServletResponse response)

  Sets the response being wrapped.
  Throws:
    java.lang.IllegalArgumentException - if the response is null.

### getCharacterEncoding

    public java.lang.String getCharacterEncoding()

  The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
  Specified by:
    getCharacterEncoding in interface ServletResponse
  Tags copied from interface: ServletResponse
  Returns:
    a `String` specifying the name of the charset, for example, `ISO-8859-1`

### getOutputStream

    public ServletOutputStream getOutputStream()
                                        throws java.io.IOException

  The default behavior of this method is to return getOutputStream() on the wrapped response object.
  Specified by:
    getOutputStream in interface ServletResponse
  Tags copied from interface: ServletResponse
  Returns:
    a `ServletOutputStream` for writing binary data
  Throws:
    java.lang.IllegalStateException - if the `getWriter` method has been called on this response
    java.io.IOException - if an input or output exception occurred
  See Also:
    `ServletResponse.getWriter()`

### getWriter

    public java.io.PrintWriter getWriter()
                                  throws java.io.IOException

  The default behavior of this method is to return getWriter() on the wrapped response object.
  Specified by:
    getWriter in interface ServletResponse
  Tags copied from interface: ServletResponse
  Returns:
    a `PrintWriter` object that can return character data to the client
  Throws:
    java.io.UnsupportedEncodingException - if the charset specified in `setContentType` cannot be used
    java.lang.IllegalStateException - if the `getOutputStream` method has already been called for this response object
    java.io.IOException - if an input or output exception occurred
  See Also:
    `ServletResponse.getOutputStream()`, `ServletResponse.setContentType(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.
  Specified by:
    setContentLength in interface ServletResponse
  Tags copied from interface: ServletResponse
  Parameters:
    `len` - an integer specifying the length of the content being returned to the client; sets the Content-Length header

### setContentType

    public void setContentType(java.lang.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
  Tags copied from interface: ServletResponse
  Parameters:
    `type` - a `String` specifying the MIME type of the content
  See Also:
    `ServletResponse.getOutputStream()`, `ServletResponse.getWriter()`

### 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
  Tags copied from interface: ServletResponse
  Parameters:
    `size` - the preferred buffer size
  Throws:
    java.lang.IllegalStateException - if this method is called after content has been written
  See Also:
    `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.
  Specified by:
    getBufferSize in interface ServletResponse
  Tags copied from interface: ServletResponse
  Returns:
    the actual buffer size used
  See Also:
    `ServletResponse.setBufferSize(int)`, `ServletResponse.flushBuffer()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

### flushBuffer

    public void flushBuffer()
                     throws java.io.IOException

  The default behavior of this method is to call flushBuffer() on the wrapped response object.
  Specified by:
    flushBuffer in interface ServletResponse
  Tags copied from interface: ServletResponse
  See Also:
    `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.
  Specified by:
    isCommitted in interface ServletResponse
  Tags copied from interface: ServletResponse
  Returns:
    a boolean indicating if the response has been committed
  See Also:
    `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.
  Specified by:
    reset in interface ServletResponse
  Tags copied from interface: ServletResponse
  Throws:
    java.lang.IllegalStateException - if the response has already been committed
  See Also:
    `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.
  Specified by:
    resetBuffer in interface ServletResponse
  Tags copied from interface: ServletResponse
  See Also:
    `ServletResponse.setBufferSize(int)`, `ServletResponse.getBufferSize()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

### setLocale

    public void setLocale(java.util.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
  Tags copied from interface: ServletResponse
  Parameters:
    `loc` - the locale of the response
  See Also:
    `ServletResponse.getLocale()`

### getLocale

    public java.util.Locale getLocale()

  The default behavior of this method is to return getLocale() on the wrapped response object.
  Specified by:
    getLocale in interface ServletResponse
  Tags copied from interface: ServletResponse
  See Also:
    `ServletResponse.setLocale(java.util.Locale)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2001 The Apache Software Foundation. All Rights Reserved.