パッケージ jakarta.servlet
クラス ServletResponseWrapper
- 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(ServletResponse wrapped)
この ServletResponseWrapper が指定されたServletResponse
インスタンスをラップするかどうかを(再帰的に)チェックします。boolean
isWrapperFor(ClassSE<?> wrappedType)
この 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)
ラップされるレスポンスを設定します。
コンストラクターの詳細
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) またはnull
) によって定義された文字セットのみを指定する文字列- 導入:
- 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 ヘッダーを設定します- 導入:
- Servlet 3.1
setContentType
public void setContentType(StringSE type)
このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentType(文字列型) を呼び出すことです。- 次で指定:
- インターフェース
ServletResponse
のsetContentType
- パラメーター:
type
- コンテンツの MIME 型を指定するString
またはnull
- 関連事項:
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() を呼び出すことです。
resetBuffer
public void resetBuffer()
このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで resetBuffer() を呼び出すことです。
setLocale
public void setLocale(LocaleSE loc)
このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで setLocale(Locale loc) を呼び出すことです。- 次で指定:
- インターフェース
ServletResponse
のsetLocale
- パラメーター:
loc
- レスポンスのロケールまたは {code @null}- 関連事項:
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