ViewHandlerWrapper (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.application.ViewHandler
- - jakarta.faces.application.ViewHandlerWrapper

実装されたすべてのインターフェース:
FacesWrapper<ViewHandler>
```
public abstract class ViewHandlerWrapper
extends ViewHandler
implements FacesWrapper<ViewHandler>
```
既存の ViewHandler インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる ViewHandler の簡単な実装を提供します。すべてのメソッドのデフォルトの実装では、ラップされた ViewHandler を呼び出します。
使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped() を使用してラップされているインスタンスにアクセスします。
導入:
1.2

フィールドサマリー
- クラス jakarta.faces.application.ViewHandler から継承されたフィールド
  CHARACTER_ENCODING_KEY, DEFAULT_FACELETS_SUFFIX, DEFAULT_SUFFIX, DEFAULT_SUFFIX_PARAM_NAME, DISABLE_FACELET_JSF_VIEWHANDLER_PARAM_NAME, FACELETS_BUFFER_SIZE_PARAM_NAME, FACELETS_DECORATORS_PARAM_NAME, FACELETS_LIBRARIES_PARAM_NAME, FACELETS_REFRESH_PERIOD_PARAM_NAME, FACELETS_SKIP_COMMENTS_PARAM_NAME, FACELETS_SUFFIX_PARAM_NAME, FACELETS_VIEW_MAPPINGS_PARAM_NAME

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

コンストラクター
コンストラクターと説明
`ViewHandlerWrapper()` 使用すべきではありません。ラップされている実装を使用する他のコンストラクターを使用します。
`ViewHandlerWrapper(ViewHandler wrapped)` このビューハンドラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addProtectedView(StringSE urlPattern)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.addProtectedView(java.lang.String)` を呼び出すことです。
`StringSE`	`calculateCharacterEncoding(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)` を呼び出すことです。
`LocaleSE`	`calculateLocale(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.calculateLocale(jakarta.faces.context.FacesContext)` を呼び出すことです。
`StringSE`	`calculateRenderKitId(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)` を呼び出すことです。
`UIViewRoot`	`createView(FacesContext context, StringSE viewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.createView(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`StringSE`	`deriveLogicalViewId(FacesContext context, StringSE requestViewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`StringSE`	`deriveViewId(FacesContext context, StringSE requestViewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`StringSE`	`getActionURL(FacesContext context, StringSE viewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`StringSE`	`getBookmarkableURL(FacesContext context, StringSE viewId, MapSE<StringSE, ListSE<StringSE>> parameters, boolean includeViewParams)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)` を呼び出すことです。
`SetSE<StringSE>`	`getProtectedViewsUnmodifiable()` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getProtectedViewsUnmodifiable()` を呼び出すことです。
`StringSE`	`getRedirectURL(FacesContext context, StringSE viewId, MapSE<StringSE, ListSE<StringSE>> parameters, boolean includeViewParams)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)` を呼び出すことです。
`StringSE`	`getResourceURL(FacesContext context, StringSE path)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`ViewDeclarationLanguage`	`getViewDeclarationLanguage(FacesContext context, StringSE viewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String)` を呼び出すことです。
`StreamSE<StringSE>`	`getViews(FacesContext context, StringSE path, int maxDepth, ViewVisitOption... options)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)` を呼び出すことです。
`StreamSE<StringSE>`	`getViews(FacesContext context, StringSE path, ViewVisitOption... options)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getViews(FacesContext, String, ViewVisitOption...)` を呼び出すことです。
`StringSE`	`getWebsocketURL(FacesContext context, StringSE channel)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.getWebsocketURL(FacesContext, String)` を呼び出すことです。
`ViewHandler`	`getWrapped()` このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
`void`	`initView(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.initView(jakarta.faces.context.FacesContext)` を呼び出すことです。
`boolean`	`removeProtectedView(StringSE urlPattern)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.removeProtectedView(java.lang.String)` を呼び出すことです。
`void`	`renderView(FacesContext context, UIViewRoot viewToRender)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)` を呼び出すことです。
`UIViewRoot`	`restoreView(FacesContext context, StringSE viewId)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.restoreView(jakarta.faces.context.FacesContext, String)` を呼び出すことです。
`void`	`writeState(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `ViewHandler` オブジェクトで `ViewHandler.writeState(jakarta.faces.context.FacesContext)` を呼び出すことです。

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

- コンストラクターの詳細
  - ViewHandlerWrapper
```
public ViewHandlerWrapper(ViewHandler wrapped)
```
    このビューハンドラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。
    パラメーター:
    wrapped - ラップされる実装。
    導入:
    2.3
  - ViewHandlerWrapper
```
@DeprecatedSE
public ViewHandlerWrapper()
```
    非推奨。ラップされている実装を取る他のコンストラクターを使用します。
- メソッドの詳細
  - getWrapped
```
public ViewHandler getWrapped()
```
    インターフェースからコピーされた説明: FacesWrapper
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
    次で指定:
    インターフェース FacesWrapper<ViewHandler> の getWrapped
    戻り値:
    ラップされたインスタンス。
  - initView
```
public void initView(FacesContext context)
              throws FacesException
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.initView(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の initView
    パラメーター:
    context - Faces コンテキスト。
    例外:
    FacesException - エンコーディングがサポートされていないときに、基盤となる Jakarta Servlet またはポートレットテクノロジによってスローされる UnsupportedEncodingException など、エンコーディングの設定で問題が発生した場合。
    導入:
    1.2
    関連事項:
    ViewHandler.initView(jakarta.faces.context.FacesContext)
  - restoreView
```
public UIViewRoot restoreView(FacesContext context,
                              StringSE viewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.restoreView(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    次で指定:
    クラス ViewHandler の restoreView
    パラメーター:
    context - 現在のリクエストの FacesContext
    viewId - 現在のリクエストのビュー識別子
    戻り値:
    復元されたビュールート、または null。
    導入:
    1.2
    関連事項:
    ViewHandler.restoreView(jakarta.faces.context.FacesContext, String)
  - createView
```
public UIViewRoot createView(FacesContext context,
                             StringSE viewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.createView(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    次で指定:
    クラス ViewHandler の createView
    パラメーター:
    context - Faces コンテキスト。
    viewId - ビュー ID。
    戻り値:
    ビュールート。
    導入:
    1.2
    関連事項:
    ViewHandler.createView(jakarta.faces.context.FacesContext, String)
  - renderView
```
public void renderView(FacesContext context,
                       UIViewRoot viewToRender)
                throws IOExceptionSE,
                       FacesException
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) を呼び出すことです。
    次で指定:
    クラス ViewHandler の renderView
    パラメーター:
    context - 現在のリクエストの FacesContext
    viewToRender - レンダリングするビュー
    例外:
    IOExceptionSE - 入出力エラーが発生した場合
    FacesException - Jakarta Servlet エラーが発生した場合
    導入:
    1.2
    関連事項:
    ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)
  - calculateCharacterEncoding
```
public StringSE calculateCharacterEncoding(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の calculateCharacterEncoding
    パラメーター:
    context - Faces コンテキスト。
    戻り値:
    文字エンコード、または null
    導入:
    1.2
    関連事項:
    ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)
  - calculateLocale
```
public LocaleSE calculateLocale(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.calculateLocale(jakarta.faces.context.FacesContext) を呼び出すことです。
    次で指定:
    クラス ViewHandler の calculateLocale
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    ロケール。
    導入:
    1.2
    関連事項:
    ViewHandler.calculateLocale(jakarta.faces.context.FacesContext)
  - deriveViewId
```
public StringSE deriveViewId(FacesContext context,
                           StringSE requestViewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の deriveViewId
    パラメーター:
    context - このリクエストの FacesContext
    requestViewId - 導出する viewId
    戻り値:
    派生ビュー ID。
    導入:
    2.0
    関連事項:
    ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)
  - deriveLogicalViewId
```
public StringSE deriveLogicalViewId(FacesContext context,
                                  StringSE requestViewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の deriveLogicalViewId
    パラメーター:
    context - このリクエストの FacesContext
    requestViewId - 導出する viewId
    戻り値:
    派生した論理ビュー ID。
    導入:
    2.1
    関連事項:
    ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)
  - calculateRenderKitId
```
public StringSE calculateRenderKitId(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext) を呼び出すことです。
    次で指定:
    クラス ViewHandler の calculateRenderKitId
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    レンダーキット ID。
    導入:
    1.2
    関連事項:
    ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)
  - getActionURL
```
public StringSE getActionURL(FacesContext context,
                           StringSE viewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    次で指定:
    クラス ViewHandler の getActionURL
    パラメーター:
    context - このリクエストの FacesContext
    viewId - 目的のビューのビュー識別子
    戻り値:
    アクション URL。
    導入:
    1.2
    関連事項:
    ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)
  - getProtectedViewsUnmodifiable
```
public SetSE<StringSE> getProtectedViewsUnmodifiable()
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getProtectedViewsUnmodifiable() を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getProtectedViewsUnmodifiable
    戻り値:
    変更できない保護されたビューのセット。
    導入:
    2.2
    関連事項:
    ViewHandler.getProtectedViewsUnmodifiable()
  - addProtectedView
```
public void addProtectedView(StringSE urlPattern)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.addProtectedView(java.lang.String) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の addProtectedView
    パラメーター:
    urlPattern - 追加する url-pattern。
    導入:
    2.2
    関連事項:
    ViewHandler.addProtectedView(java.lang.String)
  - removeProtectedView
```
public boolean removeProtectedView(StringSE urlPattern)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.removeProtectedView(java.lang.String) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の removeProtectedView
    パラメーター:
    urlPattern - 削除する url-pattern。
    戻り値:
    Set の場合は true、それ以外の場合は false。
    導入:
    2.2
    関連事項:
    ViewHandler.removeProtectedView(java.lang.String)
  - getRedirectURL
```
public StringSE getRedirectURL(FacesContext context,
                             StringSE viewId,
                             MapSE<StringSE,ListSE<StringSE>> parameters,
                             boolean includeViewParams)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getRedirectURL
    パラメーター:
    context - このリクエストを処理する FacesContext
    viewId - ターゲットページのビュー識別子
    parameters - パラメーター名の 1 つ以上の値へのマッピング
    includeViewParams - ビューパラメーターをこの URL にエンコードする必要があるかどうかを示すフラグ
    戻り値:
    リダイレクト URL。
    導入:
    2.0
    関連事項:
    ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)
  - getBookmarkableURL
```
public StringSE getBookmarkableURL(FacesContext context,
                                 StringSE viewId,
                                 MapSE<StringSE,ListSE<StringSE>> parameters,
                                 boolean includeViewParams)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getBookmarkableURL
    パラメーター:
    context - このリクエストを処理する FacesContext
    viewId - ターゲットページのビュー識別子
    parameters - パラメーター名の 1 つ以上の値へのマッピング
    includeViewParams - ビューパラメーターをこの URL にエンコードする必要があるかどうかを示すフラグ
    戻り値:
    ブックマーク可能な URL。
    導入:
    2.0
    関連事項:
    ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)
  - getResourceURL
```
public StringSE getResourceURL(FacesContext context,
                             StringSE path)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String) を呼び出すことです。
    次で指定:
    クラス ViewHandler の getResourceURL
    パラメーター:
    context - 現在のリクエストの FacesContext
    path - URL に変換するためのリソースパス
    戻り値:
    リソース URL。
    導入:
    1.2
    関連事項:
    ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)
  - getWebsocketURL
```
public StringSE getWebsocketURL(FacesContext context,
                              StringSE channel)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getWebsocketURL(FacesContext, String) を呼び出すことです。
    次で指定:
    クラス ViewHandler の getWebsocketURL
    パラメーター:
    context - 現在のリクエストの FacesContext。
    channel - WebSocket のチャネル名。
    戻り値:
    WebSocket の URL。
    導入:
    2.3
    関連事項:
    ViewHandler.getWebsocketURL(FacesContext, String)
  - getViewDeclarationLanguage
```
public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context,
                                                          StringSE viewId)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getViewDeclarationLanguage
    パラメーター:
    context - このリクエストの FacesContext
    viewId - ViewDeclarationLanguage が返される必要がある ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, java.lang.String) から返される論理ビュー ID。
    戻り値:
    ViewDeclarationLanguage、または null。
    導入:
    2.0
  - getViews
```
public StreamSE<StringSE> getViews(FacesContext context,
                               StringSE path,
                               ViewVisitOption... options)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getViews(FacesContext, String, ViewVisitOption...) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getViews
    パラメーター:
    context - このリクエストの FacesContext。
    path - ビュー ID の検索を開始する最初のパス。
    options - トラバーサルに影響を与えるオプション。これらの詳細については、ViewVisitOption を参照してください。
    戻り値:
    ビュー ID の StreamSE
    導入:
    2.3
  - getViews
```
public StreamSE<StringSE> getViews(FacesContext context,
                               StringSE path,
                               int maxDepth,
                               ViewVisitOption... options)
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...) を呼び出すことです。
    オーバーライド:
    クラス ViewHandler の getViews
    パラメーター:
    context - このリクエストの FacesContext。
    path - ビュー ID の検索を開始する最初のパス。
    maxDepth - ルート（/）から数えた、アクセスするネストされたディレクトリの絶対最大深度。
    options - トラバーサルに影響を与えるオプション。これらの詳細については、ViewVisitOption を参照してください。
    戻り値:
    ビュー ID の StreamSE
    導入:
    2.3
  - writeState
```
public void writeState(FacesContext context)
                throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされた ViewHandler オブジェクトで ViewHandler.writeState(jakarta.faces.context.FacesContext) を呼び出すことです。
    次で指定:
    クラス ViewHandler の writeState
    パラメーター:
    context - 現在のリクエストの FacesContext
    例外:
    IOExceptionSE - 入出力エラーが発生した場合
    導入:
    1.2
    関連事項:
    ViewHandler.writeState(jakarta.faces.context.FacesContext)

クラス ViewHandlerWrapper

フィールドサマリー

クラス jakarta.faces.application.ViewHandler から継承されたフィールド

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

メソッドのサマリー

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

コンストラクターの詳細

ViewHandlerWrapper

ViewHandlerWrapper

メソッドの詳細

getWrapped

initView

restoreView

createView

renderView

calculateCharacterEncoding

calculateLocale

deriveViewId

deriveLogicalViewId

calculateRenderKitId

getActionURL

getProtectedViewsUnmodifiable

addProtectedView

removeProtectedView

getRedirectURL

getBookmarkableURL

getResourceURL

getWebsocketURL

getViewDeclarationLanguage

getViews

getViews

writeState