javax.servlet
クラス ServletResponseWrapper

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
すべての実装インタフェース:
ServletResponse
直系の既知のサブクラス:
HttpServletResponseWrapper

public class ServletResponseWrapper
extends Object
implements ServletResponse

サーブレットからのレスポンスを改変したい開発者たちの手でサブクラス化による拡張を可能とする、ServletResponseインターフェースの簡潔な実装方法を提供します。 このクラスは、Wrapperパターン もしくは Decoratorパターンに基づいて実装されています。各々のメソッドは、ラップされたレスポンス・オブジェクトのメソッドをデフォルトで呼び出します。

導入されたバージョン:
v 2.3
バージョン:
$Version$
作成者:
Various
関連項目:
ServletResponse

コンストラクタの概要
ServletResponseWrapper(ServletResponse response)
          指定したレスポンス・オブジェクトをラッピングしたServletResponseアダプタを生成します。
 
メソッドの概要
 void flushBuffer()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるflushBuffer()メソッドをそのまま呼び出します。
 int getBufferSize()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetBufferSize()メソッドをそのまま呼び出します。
 String getCharacterEncoding()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetCharacterEncoding()メソッドをそのまま呼び出します。
 Locale getLocale()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetLocale()メソッドをそのまま呼び出します。
 ServletOutputStream getOutputStream()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetOutputStream()メソッドをそのまま呼び出します。
 ServletResponse getResponse()
          ラップされたServletResponseオブジェクトを返します。
 PrintWriter getWriter()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetWriter()メソッドをそのまま呼び出します。
 boolean isCommitted()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるisCommitted()メソッドをそのまま呼び出します。
 void reset()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるreset()メソッドをそのまま呼び出します。
 void resetBuffer()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるresetBuffer()メソッドをそのまま呼び出します。
 void setBufferSize(int size)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetBufferSize(int size)メソッドをそのまま呼び出します。
 void setContentLength(int len)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetContentLength(int 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アダプタを生成します。

例外:
IllegalArgumentException - response が null である場合
メソッドの詳細

getResponse

public ServletResponse getResponse()
ラップされたServletResponseオブジェクトを返します。


setResponse

public void setResponse(ServletResponse response)
ラップされるレスポンス・オブジェクトをセットします。

例外:
IllegalArgumentException - response が null である場合

getCharacterEncoding

public String getCharacterEncoding()
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetCharacterEncoding()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の getCharacterEncoding
戻り値:
文字エンコーディング名を意味する String。 例えば、ISO-8859-1

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetOutputStream()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の getOutputStream
戻り値:
バイナリデータ出力に使用する ServletOutputStream
例外:
IOException - 入出力時に例外が発生した場合
関連項目:
ServletResponse.getWriter()

getWriter

public PrintWriter getWriter()
                      throws IOException
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetWriter()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の getWriter
戻り値:
クライアントに文字データを送り返すことができる PrintWriter オブジェクト
例外:
IOException - 入出力時に例外が発生した場合
関連項目:
ServletResponse.getOutputStream(), ServletResponse.setContentType(java.lang.String)

setContentLength

public void setContentLength(int len)
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetContentLength(int len)メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の setContentLength
パラメータ:
len - クライアントに送り返すメッセージボディの長さを指定する整数値。 HTTP の Content-Length ヘッダフィールドの値

setContentType

public void setContentType(String type)
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetContentType(String type)メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の setContentType
パラメータ:
type - コンテントタイプを指定する String
関連項目:
ServletResponse.getOutputStream(), ServletResponse.getWriter()

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 IOException
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるflushBuffer()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の flushBuffer
IOException
関連項目:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()

isCommitted

public boolean isCommitted()
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるisCommitted()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の isCommitted
戻り値:
レスポンスがすでにコミットされたかどうかを示す boolean
関連項目:
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(Locale loc)
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetLocale(Locale loc)メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の setLocale
パラメータ:
loc - レスポンスのロケールを指定する java.util.Locale オブジェクト
関連項目:
ServletResponse.getLocale()

getLocale

public Locale getLocale()
このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるgetLocale()メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の getLocale
関連項目:
ServletResponse.setLocale(java.util.Locale)


このドキュメントは、Ja-Jakarta Project により翻訳されました。コメントがある場合は、jajakarta-report@jajakarta.good-day.netまでお願いします。

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