Mergedoc
Translation

javax.servlet
クラス ServletResponseWrapper

java.lang.Object
  上位を拡張 javax.servlet.ServletResponseWrapper
すべての実装されたインタフェース:
ServletResponse
直系の既知のサブクラス:
HttpServletResponseWrapper

public class ServletResponseWrapper
extends java.lang.Object
implements ServletResponse

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

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

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

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

getResponse

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


setResponse

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

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

setCharacterEncoding

public void setCharacterEncoding(java.lang.String charset)
このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトの setCharacterEncoding() メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の setCharacterEncoding
パラメータ:
charset - IANA 文字セットで定義された文字セットを示す文字列 (http://www.iana.org/assignments/character-sets)
導入されたバージョン:
2.4
関連項目:
ServletResponse.setContentType(java.lang.String), ServletResponse.setLocale(java.util.Locale)

getCharacterEncoding

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

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

getOutputStream

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

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

getWriter

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

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

setContentLength

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

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

setContentType

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

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

getContentType

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

定義:
インタフェース ServletResponse 内の getContentType
戻り値:
コンテントタイプを意味する String。 例えば、text/html; charset=UTF-8 や null
導入されたバージョン:
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 java.io.IOException
このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトの flushBuffer() メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の flushBuffer
例外:
java.io.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(java.util.Locale loc)
このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトの setLocale(Locale loc) メソッドをそのまま呼び出します。

定義:
インタフェース ServletResponse 内の setLocale
パラメータ:
loc - レスポンスのロケール
関連項目:
ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)

getLocale

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

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

Mergedoc
Translation

Copyright © 2000- The Apache Software Foundation. All rights Reserved.