Package com.sun.faces.ext.component

Class UIValidateWholeBean

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

com.sun.faces.ext.component.UIValidateWholeBean

All Implemented Interfaces:

EditableValueHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public class UIValidateWholeBean
extends UIInput
implements PartialStateHolder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAMILY

Fields inherited from class jakarta.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
UIValidateWholeBean()

Method Summary

Modifier and Type	Method	Description
final void	addValidator(Validator validator)	Add a Validator instance to the set associated with this UIInput.
void	clearInitialState()	For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder.clearInitialState() on the attached object.
void	encodeBegin(FacesContext context)	If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.
static <C extends UIComponent> C	getClosestParent(UIComponent component, Class<C> parentType)
String	getFamily()	Return the identifier of the component family to which this component belongs.
Object	getSubmittedValue()	Return the submittedValue value of this UIInput component.
String	getValidationGroups()
boolean	initialStateMarked()	An implementation of PartialStateHolder.initialStateMarked(), this method is called by the runtime to test if the PartialStateHolder.markInitialState() method was called.
boolean	isTransient()	If true, the Object implementing this interface must not participate in state saving or restoring.
void	markInitialState()	In addition to the actions taken in UIOutput when PartialStateHolder.markInitialState() is called, check if any of the installed Validators are PartialStateHolders and if so, call PartialStateHolder.markInitialState() as appropriate.
void	restoreState(FacesContext context, Object state)	Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext context)	Gets the state of the instance as a Serializable Object.
void	setConverter(Converter converter)	Set the Converter (if any) that is registered for this UIComponent.
void	setTransient(boolean transientValue)	Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
void	setValidationGroups(String validationGroups)
void	updateModel(FacesContext context)	Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate.
void	validate(FacesContext context)	Perform the following algorithm to validate the local value of this UIInput.

Methods inherited from class jakarta.faces.component.UIInput

addValueChangeListener, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, validateValue

Methods inherited from class jakarta.faces.component.UIOutput

getConverter, getLocalValue

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.faces.component.ValueHolder

getConverter, getLocalValue

Field Details

FAMILY

public static final String FAMILY

See Also:

• Constant Field Values

Constructor Details

UIValidateWholeBean

public UIValidateWholeBean()

Method Details

getFamily

public String getFamily()

Description copied from class: UIComponent

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Overrides:

getFamily in class UIInput

Returns:

the component family (not null).

getSubmittedValue

public Object getSubmittedValue()

Description copied from class: UIInput

Return the submittedValue value of this UIInput component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer.

Specified by:

getSubmittedValue in interface EditableValueHolder

Overrides:

getSubmittedValue in class UIInput

Returns:

the submitted value.

setConverter

public void setConverter(Converter converter)

Description copied from interface: ValueHolder

Set the Converter (if any) that is registered for this UIComponent.

Specified by:

setConverter in interface ValueHolder

Overrides:

setConverter in class UIOutput

Parameters:

converter - New Converter (or null)

addValidator

public final void addValidator(Validator validator)

Description copied from class: UIInput

Add a Validator instance to the set associated with this UIInput.

Specified by:

addValidator in interface EditableValueHolder

Overrides:

addValidator in class UIInput

Parameters:

validator - The Validator to add

setValidationGroups

public void setValidationGroups(String validationGroups)

getValidationGroups

public String getValidationGroups()

validate

public void validate(FacesContext context)

Description copied from class: UIInput

Perform the following algorithm to validate the local value of this UIInput.

• Retrieve the submitted value with UIInput.getSubmittedValue(). If this returns null, and the value of the UIInput.ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE context-param is true (ignoring case), examine the value of the "required" property. If the value of "required" is true, continue as below. If the value of "required" is false or the required attribute is not set, exit without further processing. If the context-param is not set, or is set to false (ignoring case), exit without further processing. (This indicates that no value was submitted for this component.)
• If the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL context parameter value is true (ignoring case), and getSubmittedValue() returns a zero-length String call UIInput.setSubmittedValue(java.lang.Object), passing null as the argument and continue processing using null as the current submitted value.
• Convert the submitted value into a "local value" of the appropriate data type by calling UIInput.getConvertedValue(jakarta.faces.context.FacesContext, java.lang.Object).
• If conversion fails:
  • Enqueue an appropriate error message by calling the addMessage() method on the FacesContext.
  • Set the valid property on this component to false
• Validate the property by calling UIInput.validateValue(jakarta.faces.context.FacesContext, java.lang.Object).
• If the valid property of this component is still true, retrieve the previous value of the component (with getValue()), store the new local value using setValue(), and reset the submitted value to null with a call to UIInput.setSubmittedValue(java.lang.Object) passing null as the argument. If the local value is different from the previous value of this component, as determined by a call to UIInput.compareValues(java.lang.Object, java.lang.Object), fire a ValueChangeEvent to be broadcast to all interested listeners.

Application components implementing UIInput that wish to perform validation with logic embedded in the component should perform their own correctness checks, and then call the super.validate() method to perform the standard processing described above.

Overrides:

validate in class UIInput

Parameters:

context - The FacesContext for the current request

updateModel

public void updateModel(FacesContext context)

Description copied from class: UIInput

Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate.

• If the valid property of this component is false, take no further action.
• If the localValueSet property of this component is false, take no further action.
• If no ValueExpression for value exists, take no further action.
• Call setValue() method of the ValueExpression to update the value that the ValueExpression points at.
• If the setValue() method returns successfully:
  • Clear the local value of this UIInput.
  • Set the localValueSet property of this UIInput to false.
• If the setValue() method throws an Exception:
  • Enqueue an error message. Create a FacesMessage with the id UIInput.UPDATE_MESSAGE_ID. Create a UpdateModelException, passing the FacesMessage and the caught exception to the constructor. Create an ExceptionQueuedEventContext, passing the FacesContext, the UpdateModelException, this component instance, and PhaseId.UPDATE_MODEL_VALUES to its constructor. Call FacesContext.getExceptionHandler() and then call ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent), passing the ExceptionQueuedEventContext.
  • Set the valid property of this UIInput to false.
  The exception must not be re-thrown. This enables tree traversal to continue for this lifecycle phase, as in all the other lifecycle phases.

Overrides:

updateModel in class UIInput

Parameters:

context - FacesContext for the request we are processing

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Description copied from class: UIComponent

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object), passing PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

If our rendered property is false, call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and return immediately.

Overrides:

encodeBegin in class UIComponentBase

Parameters:

context - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

getClosestParent

public static <C extends UIComponent> C getClosestParent(UIComponent component,
 Class<C> parentType)

markInitialState

public void markInitialState()

Description copied from class: UIInput

In addition to the actions taken in UIOutput when PartialStateHolder.markInitialState() is called, check if any of the installed Validators are PartialStateHolders and if so, call PartialStateHolder.markInitialState() as appropriate.

Specified by:

markInitialState in interface PartialStateHolder

Overrides:

markInitialState in class UIInput

initialStateMarked

public boolean initialStateMarked()

Description copied from class: UIComponent

An implementation of PartialStateHolder.initialStateMarked(), this method is called by the runtime to test if the PartialStateHolder.markInitialState() method was called.

Specified by:

initialStateMarked in interface PartialStateHolder

Overrides:

initialStateMarked in class UIComponent

Returns:

true if the initial state is marked, false otherwise.

clearInitialState

public void clearInitialState()

Description copied from class: UIComponentBase

For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder.clearInitialState() on the attached object.

Specified by:

clearInitialState in interface PartialStateHolder

Overrides:

clearInitialState in class UIInput

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

Overrides:

isTransient in class UIComponentBase

Returns:

true if transient, false otherwise.

setTransient

public void setTransient(boolean transientValue)

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

Overrides:

setTransient in class UIComponentBase

Parameters:

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

saveState

public Object saveState(FacesContext context)

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

Overrides:

saveState in class UIInput

Parameters:

context - the Faces context.

Returns:

the saved state.

restoreState

public void restoreState(FacesContext context,
 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

Overrides:

restoreState in class UIInput

Parameters:

context - the Faces context.

state - the state.