Module jakarta.faces

Package com.sun.faces.util

Class ComponentStruct

java.lang.Object

com.sun.faces.util.ComponentStruct

All Implemented Interfaces:

StateHolder

public class ComponentStruct
extends Object
implements StateHolder

Utility class to enable partial state saving of components that have been dynamically added to the view.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD	Marker that specifies this is an ADD.
static final String	REMOVE	Marker that specifies this is a REMOVE.

Constructor Summary

Constructors

Constructor	Description
ComponentStruct()
ComponentStruct(String action, String facetName, String clientId, String id)
ComponentStruct(String action, String facetName, String parentClientId, String clientId, String id)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAction()
String	getClientId()
String	getFacetName()
String	getId()
String	getParentClientId()
int	hashCode()	Hash code.
boolean	isTransient()	If true, the Object implementing this interface must not participate in state saving or restoring.
void	restoreState(FacesContext ctx, Object state)	Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext ctx)	Gets the state of the instance as a Serializable Object.
void	setTransient(boolean trans)	Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ADD

public static final String ADD

Marker that specifies this is an ADD.

See Also:

• Constant Field Values

REMOVE

public static final String REMOVE

Marker that specifies this is a REMOVE.

See Also:

• Constant Field Values

Constructor Details

ComponentStruct

public ComponentStruct()

ComponentStruct

public ComponentStruct(String action,
 String facetName,
 String clientId,
 String id)

ComponentStruct

public ComponentStruct(String action,
 String facetName,
 String parentClientId,
 String clientId,
 String id)

Method Details

isTransient

public boolean isTransient()

Description copied from interface: StateHolder

If true, the Object implementing this interface must not participate in state saving or restoring.

Specified by:

isTransient in interface StateHolder

Returns:

true if transient, false otherwise.

restoreState

public void restoreState(FacesContext ctx,
 Object state)

Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

If the state argument is null, take no action and return.

Specified by:

restoreState in interface StateHolder

Parameters:

ctx - the Faces context.

state - the state.

saveState

public Object saveState(FacesContext ctx)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 
 Object state = component.saveState(facesContext);
 
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface StateHolder

Parameters:

ctx - the Faces context.

Returns:

the saved state.

setTransient

public void setTransient(boolean trans)

Description copied from interface: StateHolder

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Specified by:

setTransient in interface StateHolder

Parameters:

trans - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class Object

Returns:

the hashcode.

getAction

public String getAction()

getFacetName

public String getFacetName()

getParentClientId

public String getParentClientId()

getClientId

public String getClientId()

getId

public String getId()