ServletResponseWrapper (Java Servlet 4.0)

java.lang.Object
- javax.servlet.ServletResponseWrapper

すべての実装されたインタフェース:

ServletResponse

直系の既知のサブクラス:

HttpServletResponseWrapper
```
public class ServletResponseWrapper
extends Object
implements ServletResponse
```
サーブレットにレスポンスを適合させたい開発者がサブクラス化できるServletResponseインターフェースの便利な実装を提供します。このクラスはWrapperもしくはDecoratorパターンを実装します。メソッドはデフォルトでラップされたリクエストオブジェクトを呼び出します。

作成者:

Various

導入されたバージョン:

Servlet 2.3

関連項目:

ServletResponse

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

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

メソッドのサマリー

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

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ServletResponseWrapper
```
public ServletResponseWrapper(ServletResponse response)
```
    指定されたレスポンスオブジェクトをラップするServletResponseアダプタを作成します。
    
    パラメータ:
    
    response - ラップされるServletResponse
    
    例外:
    
    IllegalArgumentException - responseがnull
- メソッドの詳細
  - getResponse
```
public ServletResponse getResponse()
```
    ラップされたServletResponseのオブジェクトを返します。
    
    戻り値:
    
    ラップされたServletResponse
  - setResponse
```
public void setResponse(ServletResponse response)
```
    ラップされているレスポンスを設定します。
    
    パラメータ:
    
    response - 取り付けられる ServletResponse
    
    例外:
    
    IllegalArgumentException - responseがnull
  - setCharacterEncoding
```
public void setCharacterEncoding(String charset)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetCharacterEncoding(String charset)を呼び出すことです。
    
    定義:
    
    setCharacterEncoding インタフェース内 ServletResponse
    
    パラメータ:
    
    charset - IANA 定義の文字セットを示す文字列 (http://www.iana.org/assignments/character-sets)
    
    導入されたバージョン:
    
    Servlet 2.4
    
    関連項目:
    
    ServletResponse.setContentType(java.lang.String), ServletResponse.setLocale(java.util.Locale)
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetCharacterEncoding()を返すことです。
    
    定義:
    
    getCharacterEncoding インタフェース内 ServletResponse
    
    戻り値:
    
    文字エンコーディングの名前を示すString、例としてUTF-8
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetOutputStream()を返すことです。
    
    定義:
    
    getOutputStream インタフェース内 ServletResponse
    
    戻り値:
    
    バイナリデータを書き出すためのServletOutputStream
    
    例外:
    
    IOException - I/Oエラーが発生した
    
    関連項目:
    
    ServletResponse.getWriter(), ServletResponse.reset()
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetWriter()を返すことです。
    
    定義:
    
    getWriter インタフェース内 ServletResponse
    
    戻り値:
    
    文字データをクライアントに返すことができる PrintWriterオブジェクト
    
    例外:
    
    UnsupportedEncodingException - getCharacterEncodingから返された文字エンコーディングが使用できない文字エンコーディングだった
    
    IOException - I/Oエラーが発生した
    
    関連項目:
    
    ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.reset()
  - setContentLength
```
public void setContentLength(int len)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetContentLength(int len)を呼び出すことです。
    
    定義:
    
    setContentLength インタフェース内 ServletResponse
    
    パラメータ:
    
    len - クライアントに返されるコンテンツの長さを指定するinteger、Content-Lengthヘッダーを設定する
  - setContentLengthLong
```
public void setContentLengthLong(long len)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetContentLengthLong(long len)を呼び出すことです。
    
    定義:
    
    setContentLengthLong インタフェース内 ServletResponse
    
    パラメータ:
    
    len - クライアントに返されるコンテンツの長さを指定するlong、Content-Lengthヘッダーを設定する
  - setContentType
```
public void setContentType(String type)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetContentType(String type)を呼び出すことです。
    
    定義:
    
    setContentType インタフェース内 ServletResponse
    
    パラメータ:
    
    type - コンテンツのMIMEタイプを示すString
    
    関連項目:
    
    ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()
  - getContentType
```
public String getContentType()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetContentType()を返すことです。
    
    定義:
    
    getContentType インタフェース内 ServletResponse
    
    戻り値:
    
    コンテンツタイプを示すString、例としてtext/html; charset=UTF-8、もしくはnull
    
    導入されたバージョン:
    
    Servlet 2.4
  - setBufferSize
```
public void setBufferSize(int size)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetBufferSize(int size)を呼び出すことです。
    
    定義:
    
    setBufferSize インタフェース内 ServletResponse
    
    パラメータ:
    
    size - 好ましいバッファーサイズ
    
    関連項目:
    
    ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()
  - getBufferSize
```
public int getBufferSize()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetBufferSize()を返すことです。
    
    定義:
    
    getBufferSize インタフェース内 ServletResponse
    
    戻り値:
    
    実際に使用されているバッファーサイズ
    
    関連項目:
    
    ServletResponse.setBufferSize(int), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのflushBuffer()を呼び出すことです。
    
    定義:
    
    flushBuffer インタフェース内 ServletResponse
    
    例外:
    
    IOException - バッファーを完全にフラッシュすることができなかった
    
    関連項目:
    
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()
  - isCommitted
```
public boolean isCommitted()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのisCommitted()を返すことです。
    
    定義:
    
    isCommitted インタフェース内 ServletResponse
    
    戻り値:
    
    レスポンスがすでにコミットされているかどうかを示すboolean
    
    関連項目:
    
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.reset()
  - reset
```
public void reset()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのreset()を呼び出すことです。
    
    定義:
    
    reset インタフェース内 ServletResponse
    
    関連項目:
    
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted()
  - resetBuffer
```
public void resetBuffer()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのresetBuffer()を呼び出すことです。
    
    定義:
    
    resetBuffer インタフェース内 ServletResponse
    
    関連項目:
    
    ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()
  - setLocale
```
public void setLocale(Locale loc)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetLocale(Locale loc)を呼び出すことです。
    
    定義:
    
    setLocale インタフェース内 ServletResponse
    
    パラメータ:
    
    loc - レスポンスのロケール
    
    関連項目:
    
    ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)
  - getLocale
```
public Locale getLocale()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのgetLocale()を返すことです。
    
    定義:
    
    getLocale インタフェース内 ServletResponse
    
    戻り値:
    
    このレスポンスのロケール
    
    関連項目:
    
    ServletResponse.setLocale(java.util.Locale)
  - isWrapperFor
```
public boolean isWrapperFor(ServletResponse wrapped)
```
    このServletResponseWrapperが与えられたServletResponseのインスタンスをラップしているかどうかを(再帰的に)チェックします。
    
    パラメータ:
    
    wrapped - 探すServletResponseのインスタンス
    
    戻り値:
    
    与えられたServletResponseのインスタンスをServletResponseWrapperがラップしているならtrue、そうでないならfalse
    
    導入されたバージョン:
    
    Servlet 3.0
  - isWrapperFor
```
public boolean isWrapperFor(Class<?> wrappedType)
```
    このServletResponseWrapperが与えられたClassの型のServletResponse をラップしているかどうかを(再帰的に)チェックします。
    
    パラメータ:
    
    wrappedType - 探すServletResponseのclassの型
    
    戻り値:
    
    与えられたClassの型のServletResponseをServletResponseWrapperがラップしているならtrue、そうでないならfalse
    
    例外:
    
    IllegalArgumentException - 与えられたclassがServletResponseを実装していない場合
    
    導入されたバージョン:
    
    Servlet 3.0

Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.

クラス ServletResponseWrapper

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

メソッドのサマリー

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

コンストラクタの詳細

ServletResponseWrapper

メソッドの詳細

getResponse

setResponse

setCharacterEncoding

getCharacterEncoding

getOutputStream

getWriter

setContentLength

setContentLengthLong

setContentType

getContentType

setBufferSize

getBufferSize

flushBuffer

isCommitted

reset

resetBuffer

setLocale

getLocale

isWrapperFor

isWrapperFor