StateManagerWrapper (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.application.StateManager
- - jakarta.faces.application.StateManagerWrapper

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

ネストされたクラスの要約
- クラス jakarta.faces.application.StateManager から継承されたネストクラス / インターフェース
  StateManager.SerializedView

フィールドのサマリー
- クラス jakarta.faces.application.StateManager から継承されたフィールド
  FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME, IS_BUILDING_INITIAL_STATE, IS_SAVING_STATE, PARTIAL_STATE_SAVING_PARAM_NAME, SERIALIZE_SERVER_STATE_PARAM_NAME, STATE_SAVING_METHOD_CLIENT, STATE_SAVING_METHOD_PARAM_NAME, STATE_SAVING_METHOD_SERVER

コンストラクターの概要

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`getComponentStateToSave(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)` を呼び出すことです。
`protected ObjectSE`	`getTreeStructureToSave(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)` を呼び出すことです。
`StringSE`	`getViewState(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.getViewState(jakarta.faces.context.FacesContext)` を呼び出すことです。
`StateManager`	`getWrapped()` このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
`boolean`	`isSavingStateInClient(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)` を呼び出すことです。
`protected void`	`restoreComponentState(FacesContext context, UIViewRoot viewRoot, StringSE renderKitId)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)` を呼び出すことです。
`protected UIViewRoot`	`restoreTreeStructure(FacesContext context, StringSE viewId, StringSE renderKitId)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)` を呼び出すことです。
`UIViewRoot`	`restoreView(FacesContext context, StringSE viewId, StringSE renderKitId)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)` を呼び出すことです。
`StateManager.SerializedView`	`saveSerializedView(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.saveSerializedView(jakarta.faces.context.FacesContext)` を呼び出すことです。
`ObjectSE`	`saveView(FacesContext context)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.saveView(jakarta.faces.context.FacesContext)` を呼び出すことです。
`void`	`writeState(FacesContext context, ObjectSE state)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)` を呼び出すことです。
`void`	`writeState(FacesContext context, StateManager.SerializedView state)` このメソッドのデフォルトの動作は、ラップされた `StateManager` オブジェクトで `StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)` を呼び出すことです。

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

- コンストラクターの詳細
  - StateManagerWrapper
```
@DeprecatedSE
public StateManagerWrapper()
```
    非推奨。ラップされている実装を取る他のコンストラクターを使用します。
  - StateManagerWrapper
```
public StateManagerWrapper(StateManager wrapped)
```
    この状態マネージャーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。
    パラメーター:
    wrapped - ラップされる実装。
    導入:
    2.3
- メソッドの詳細
  - getWrapped
```
public StateManager getWrapped()
```
    インターフェースからコピーされた説明: FacesWrapper
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
    次で指定:
    インターフェース FacesWrapper<StateManager> の getWrapped
    戻り値:
    ラップされたインスタンス。
  - saveSerializedView
```
public StateManager.SerializedView saveSerializedView(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.saveSerializedView(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の saveSerializedView
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    直列化されたビュー、または null
    導入:
    1.2
    関連事項:
    StateManager.saveSerializedView(jakarta.faces.context.FacesContext)
  - saveView
```
public ObjectSE saveView(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.saveView(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の saveView
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    保存されたビュー。
    導入:
    1.2
    関連事項:
    StateManager.saveView(jakarta.faces.context.FacesContext)
  - getTreeStructureToSave
```
protected ObjectSE getTreeStructureToSave(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の getTreeStructureToSave
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    ツリー構造、または null
    導入:
    1.2
    関連事項:
    StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)
  - getComponentStateToSave
```
protected ObjectSE getComponentStateToSave(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の getComponentStateToSave
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    コンポーネントの状態、または null
    導入:
    1.2
    関連事項:
    StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)
  - writeState
```
public void writeState(FacesContext context,
                       ObjectSE state)
                throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object) を呼び出すことです。
    オーバーライド:
    クラス StateManager の writeState
    パラメーター:
    context - 現在のリクエストの FacesContext
    state - StateManager.saveSerializedView(jakarta.faces.context.FacesContext) によって返される、書き込まれる直列化可能な状態
    例外:
    IOExceptionSE - I/O エラーが発生したとき。
    導入:
    1.2
    関連事項:
    StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
  - writeState
```
public void writeState(FacesContext context,
                       StateManager.SerializedView state)
                throws IOExceptionSE
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView) を呼び出すことです。
    オーバーライド:
    クラス StateManager の writeState
    パラメーター:
    context - 現在のリクエストの FacesContext
    state - 書き込まれる直列化された状態
    例外:
    IOExceptionSE - I/O エラーが発生したとき。
    導入:
    1.2
    関連事項:
    StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
  - restoreView
```
public UIViewRoot restoreView(FacesContext context,
                              StringSE viewId,
                              StringSE renderKitId)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.restoreView(jakarta.faces.context.FacesContext, String, String) を呼び出すことです。
    次で指定:
    クラス StateManager の restoreView
    パラメーター:
    context - 現在のリクエストの FacesContext
    viewId - 復元するビューのビュー識別子
    renderKitId - このレスポンスをレンダリングするために使用される renderKitId。null であってはなりません。
    戻り値:
    ビューのルート、または null。
    導入:
    1.2
    関連事項:
    StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
  - restoreTreeStructure
```
protected UIViewRoot restoreTreeStructure(FacesContext context,
                                          StringSE viewId,
                                          StringSE renderKitId)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String) を呼び出すことです。
    オーバーライド:
    クラス StateManager の restoreTreeStructure
    パラメーター:
    context - 現在のリクエストの FacesContext
    viewId - 復元するビューのビュー識別子
    renderKitId - このレスポンスをレンダリングするために使用される renderKitId。null であってはなりません。
    戻り値:
    ビューのルート、または null。
    導入:
    1.2
    関連事項:
    StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)
  - restoreComponentState
```
protected void restoreComponentState(FacesContext context,
                                     UIViewRoot viewRoot,
                                     StringSE renderKitId)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String) を呼び出すことです。
    オーバーライド:
    クラス StateManager の restoreComponentState
    パラメーター:
    context - 現在のリクエストの FacesContext
    viewRoot - restoreTreeStructure() への以前の呼び出しによって返された UIViewRoot
    renderKitId - このレスポンスをレンダリングするために使用される renderKitId。null であってはなりません。
    導入:
    1.2
    関連事項:
    StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
  - isSavingStateInClient
```
public boolean isSavingStateInClient(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の isSavingStateInClient
    パラメーター:
    context - Faces コンテキスト。
    戻り値:
    true は、定数 StateManager.STATE_SAVING_METHOD_PARAM_NAME の値によって指定された ServletContext init パラメーターの値が定数 StateManager.STATE_SAVING_METHOD_CLIENT の値と等しい（大文字と小文字を区別しない）場合に限ります。それ以外の場合は false。
    導入:
    1.2
    関連事項:
    StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
  - getViewState
```
public StringSE getViewState(FacesContext context)
```
    このメソッドのデフォルトの動作は、ラップされた StateManager オブジェクトで StateManager.getViewState(jakarta.faces.context.FacesContext) を呼び出すことです。
    オーバーライド:
    クラス StateManager の getViewState
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    ビューステート。
    導入:
    2.0

クラス StateManagerWrapper

ネストされたクラスの要約

クラス jakarta.faces.application.StateManager から継承されたネストクラス / インターフェース

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

コンストラクターの詳細

StateManagerWrapper

StateManagerWrapper

メソッドの詳細

getWrapped

saveSerializedView

saveView

getTreeStructureToSave

getComponentStateToSave

writeState

writeState

restoreView

restoreTreeStructure

restoreComponentState

isSavingStateInClient

getViewState