ServletResponseWrapper (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.servlet.ServletResponseWrapper

実装されたすべてのインターフェース:
ServletResponse
既知の直属サブクラス
HttpServletResponseWrapper
```
public class ServletResponseWrapper
extends ObjectSE
implements ServletResponse
```
サーブレットからのレスポンスを適応させたい開発者がサブクラス化できる、ServletResponse インターフェースの便利な実装を提供します。このクラスは、Wrapper または Decorator パターンを実装します。メソッドは、ラップされたレスポンスオブジェクトへの呼び出しをデフォルトで実行します。
導入:
Servlet 2.3
作成者:
Various
関連事項:
ServletResponse

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`ServletResponseWrapper(ServletResponse response)` 指定されたレスポンスオブジェクトをラップする ServletResponse アダプターを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`flushBuffer()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで flushBuffer() を呼び出すことです。
`int`	`getBufferSize()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getBufferSize() を返すことです。
`StringSE`	`getCharacterEncoding()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getCharacterEncoding() を返すことです。
`StringSE`	`getContentType()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getContentType() を返すことです。
`LocaleSE`	`getLocale()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getLocale() を返すことです。
`ServletOutputStream`	`getOutputStream()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getOutputStream() を返すことです。
`ServletResponse`	`getResponse()` ラップされた ServletResponse オブジェクトを返します。
`PrintWriterSE`	`getWriter()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getWriter() を返すことです。
`boolean`	`isCommitted()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで isCommitted() を返すことです。
`boolean`	`isWrapperFor(ClassSE<?> wrappedType)` この ServletResponseWrapper が指定されたクラス型の `ServletResponse` をラップするかどうかを（再帰的に）チェックします。
`boolean`	`isWrapperFor(ServletResponse wrapped)` この ServletResponseWrapper が指定された `ServletResponse` インスタンスをラップするかどうかを（再帰的に）チェックします。
`void`	`reset()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで reset() を呼び出すことです。
`void`	`resetBuffer()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで resetBuffer() を呼び出すことです。
`void`	`setBufferSize(int size)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setBufferSize(int size) を呼び出すことです。
`void`	`setCharacterEncoding(StringSE charset)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで setCharacterEncoding(String charset) を呼び出すことです。
`void`	`setContentLength(int len)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLength(int len) を呼び出すことです。
`void`	`setContentLengthLong(long len)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLengthLong(long len) を呼び出すことです。
`void`	`setContentType(StringSE type)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentType(文字列型) を呼び出すことです。
`void`	`setLocale(LocaleSE loc)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで setLocale(Locale loc) を呼び出すことです。
`void`	`setResponse(ServletResponse response)` ラップされるレスポンスを設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ServletResponseWrapper
```
public ServletResponseWrapper(ServletResponse response)
```
    指定されたレスポンスオブジェクトをラップする ServletResponse アダプターを作成します。
    パラメーター:
    response - ラップされる ServletResponse
    例外:
    IllegalArgumentExceptionSE - レスポンスが null の場合。
- メソッドの詳細
  - getResponse
```
public ServletResponse getResponse()
```
    ラップされた ServletResponse オブジェクトを返します。
    戻り値:
    ラップされた ServletResponse
  - setResponse
```
public void setResponse(ServletResponse response)
```
    ラップされるレスポンスを設定します。
    パラメーター:
    response - インストールする ServletResponse
    例外:
    IllegalArgumentExceptionSE - レスポンスが null の場合。
  - setCharacterEncoding
```
public void setCharacterEncoding(StringSE charset)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで setCharacterEncoding(String charset) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setCharacterEncoding
    パラメーター:
    charset - IANA 文字セットで定義された文字セットのみを指定する文字列 (http://www.iana.org/assignments/character-sets)
    導入:
    Servlet 2.4
    関連事項:
    ServletResponse.setContentType(java.lang.String), ServletResponse.setLocale(java.util.Locale)
  - getCharacterEncoding
```
public StringSE getCharacterEncoding()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getCharacterEncoding() を返すことです。
    次で指定:
    インターフェース ServletResponse の getCharacterEncoding
    戻り値:
    文字エンコードの名前を指定する String、たとえば UTF-8
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getOutputStream() を返すことです。
    次で指定:
    インターフェース ServletResponse の getOutputStream
    戻り値:
    バイナリデータを書き込むための ServletOutputStream
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
    関連事項:
    ServletResponse.getWriter(), ServletResponse.reset()
  - getWriter
```
public PrintWriterSE getWriter()
                      throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getWriter() を返すことです。
    次で指定:
    インターフェース ServletResponse の getWriter
    戻り値:
    クライアントに文字データを返すことができる PrintWriter オブジェクト
    例外:
    UnsupportedEncodingExceptionSE - getCharacterEncoding によって返された文字エンコードを使用できない場合
    IOExceptionSE - 入力または出力の例外が発生した場合
    関連事項:
    ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.reset()
  - setContentLength
```
public void setContentLength(int len)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLength(int len) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setContentLength
    パラメーター:
    len - クライアントに返されるコンテンツの長さを指定する整数。Content-Length ヘッダーを設定します
  - setContentLengthLong
```
public void setContentLengthLong(long len)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLengthLong(long len) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setContentLengthLong
    パラメーター:
    len - クライアントに返されるコンテンツの長さを指定する long; Content-Length ヘッダーを設定します
  - setContentType
```
public void setContentType(StringSE type)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentType(文字列型) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setContentType
    パラメーター:
    type - コンテンツの MIME 型を指定する String
    関連事項:
    ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()
  - getContentType
```
public StringSE getContentType()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getContentType() を返すことです。
    次で指定:
    インターフェース ServletResponse の getContentType
    戻り値:
    text/html; charset=UTF-8 などのコンテンツ型を指定する String または null
    導入:
    Servlet 2.4
  - setBufferSize
```
public void setBufferSize(int size)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setBufferSize(int size) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setBufferSize
    パラメーター:
    size - 優先バッファサイズ
    関連事項:
    ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()
  - getBufferSize
```
public int getBufferSize()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getBufferSize() を返すことです。
    次で指定:
    インターフェース ServletResponse の getBufferSize
    戻り値:
    使用される実際のバッファサイズ
    関連事項:
    ServletResponse.setBufferSize(int), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()
  - flushBuffer
```
public void flushBuffer()
                 throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで flushBuffer() を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の flushBuffer
    例外:
    IOExceptionSE - バッファをフラッシュする動作を完了できない場合。
    関連事項:
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()
  - isCommitted
```
public boolean isCommitted()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで isCommitted() を返すことです。
    次で指定:
    インターフェース ServletResponse の isCommitted
    戻り値:
    レスポンスがコミットされたかどうかを示すブール値
    関連事項:
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.reset()
  - reset
```
public void reset()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで reset() を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の reset
    関連事項:
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted()
  - resetBuffer
```
public void resetBuffer()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで resetBuffer() を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の resetBuffer
    関連事項:
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()
  - setLocale
```
public void setLocale(LocaleSE loc)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで setLocale(Locale loc) を呼び出すことです。
    次で指定:
    インターフェース ServletResponse の setLocale
    パラメーター:
    loc - レスポンスのロケール
    関連事項:
    ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)
  - getLocale
```
public LocaleSE getLocale()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getLocale() を返すことです。
    次で指定:
    インターフェース ServletResponse の getLocale
    戻り値:
    このレスポンスのロケール。
    関連事項:
    ServletResponse.setLocale(java.util.Locale)
  - isWrapperFor
```
public boolean isWrapperFor(ServletResponse wrapped)
```
    この ServletResponseWrapper が指定された ServletResponse インスタンスをラップするかどうかを（再帰的に）チェックします。
    パラメーター:
    wrapped - 検索する ServletResponse インスタンス
    戻り値:
    この ServletResponseWrapper が指定された ServletResponse インスタンスをラップする場合は true、そうでない場合は false
    導入:
    Servlet 3.0
  - isWrapperFor
```
public boolean isWrapperFor(ClassSE<?> wrappedType)
```
    この ServletResponseWrapper が指定されたクラス型の ServletResponse をラップするかどうかを（再帰的に）チェックします。
    パラメーター:
    wrappedType - 検索する ServletResponse クラス型
    戻り値:
    この ServletResponseWrapper が指定されたクラス型の ServletResponse をラップする場合は true、そうでない場合は false
    例外:
    IllegalArgumentExceptionSE - 指定されたクラスが ServletResponse を実装していない場合
    導入:
    Servlet 3.0

クラス ServletResponseWrapper

コンストラクターのサマリー

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ServletResponseWrapper

メソッドの詳細

getResponse

setResponse

setCharacterEncoding

getCharacterEncoding

getOutputStream

getWriter

setContentLength

setContentLengthLong

setContentType

getContentType

setBufferSize

getBufferSize

flushBuffer

isCommitted

reset

resetBuffer

setLocale

getLocale

isWrapperFor

isWrapperFor