Module jakarta.faces

Package jakarta.faces.component

Interface TransientStateHelper

All Superinterfaces:

TransientStateHolder

public interface TransientStateHelper
extends TransientStateHolder

Define a Map-like contract that makes it easier for components to implement TransientStateHolder. Each UIComponent in the view will return an implementation of this interface from its UIComponent.getTransientStateHelper() method.

The values retrieved or saved through getTransient(java.lang.Object) or putTransient(java.lang.Object, java.lang.Object) will not be preserved between requests.

Since:

2.1

Method Summary

Modifier and Type	Method	Description
Object	getTransient(Object key)	Return the value currently associated with the specified key if any.
Object	getTransient(Object key, Object defaultValue)	Performs the same logic as getTransient(java.lang.Object) } but if no value is found, this will return the specified defaultValue
Object	putTransient(Object key, Object value)	Return the previously stored value and store the specified key/value pair.

Methods inherited from interface jakarta.faces.component.TransientStateHolder

restoreTransientState, saveTransientState

Method Details

getTransient

Object getTransient(Object key)

Return the value currently associated with the specified key if any.

Parameters:

key - the key for which the value should be returned.

Returns:

the stored value.

Since:

2.1

getTransient

Object getTransient(Object key,
 Object defaultValue)

Performs the same logic as getTransient(java.lang.Object) } but if no value is found, this will return the specified defaultValue

Parameters:

key - the key for which the value should be returned.

defaultValue - the value to return if no value is found in the call to get().

Returns:

the stored value.

Since:

2.1

putTransient

Object putTransient(Object key,
 Object value)

Return the previously stored value and store the specified key/value pair. This is intended to store data that would otherwise reside in an instance variable on the component.

Parameters:

key - the key for the value

value - the value

Returns:

the previously stored value

Since:

2.1