Top Description Methods
jakarta.faces.component

public Interface PartialStateHolder

extends StateHolder
Known Direct Implementers
jakarta.faces.component.UIComponent, jakarta.faces.component.behavior.BehaviorBase, jakarta.faces.convert.DateTimeConverter, jakarta.faces.convert.EnumConverter, jakarta.faces.convert.NumberConverter, jakarta.faces.validator.BeanValidator, jakarta.faces.validator.DoubleRangeValidator, jakarta.faces.validator.LengthValidator, jakarta.faces.validator.LongRangeValidator, jakarta.faces.validator.RegexValidator, com.sun.faces.ext.component.UIValidateWholeBean, jakarta.faces.component.AttachedObjectListHolder

Components that want to leverage the partial state saving feature must implement this interface instead of implementing StateHolder, from which this interface inherits.

Since
2.0

Method Summary

Modifier and TypeMethod and Description
public void
clearInitialState()

Reset the PartialStateHolder to a non-delta tracking state.

public boolean

Returns:

true if the initial state is marked, false otherwise.
initialStateMarked()

Return true if delta state changes are being tracked, otherwise false

public void
markInitialState()

The runtime must ensure that the markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state.

Inherited from jakarta.faces.component.StateHolder:
isTransientrestoreStatesaveStatesetTransient

Method Detail

clearInitialStateback to summary
public void clearInitialState()

Reset the PartialStateHolder to a non-delta tracking state.

Since
2.0
initialStateMarkedback to summary
public boolean initialStateMarked()

Return true if delta state changes are being tracked, otherwise false

Returns:boolean

true if the initial state is marked, false otherwise.

Since
2.0
markInitialStateback to summary
public void markInitialState()

The runtime must ensure that the markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that initialStateMarked returns true from the time markInitialState() is called until clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState.

Since
2.0