Class ValidatorHandler

java.lang.Object

jakarta.faces.view.facelets.TagHandler

jakarta.faces.view.facelets.MetaTagHandler

jakarta.faces.view.facelets.DelegatingMetaTagHandler

jakarta.faces.view.facelets.FaceletsAttachedObjectHandler

jakarta.faces.view.facelets.ValidatorHandler

All Implemented Interfaces:

AttachedObjectHandler, EditableValueHolderAttachedObjectHandler, FaceletHandler, ValueHolderAttachedObjectHandler

public class ValidatorHandler
extends FaceletsAttachedObjectHandler
implements EditableValueHolderAttachedObjectHandler

Handles setting a Validator instance on an EditableValueHolder parent. Will wire all attributes set to the Validator instance created/fetched. Uses the "binding" attribute for grabbing instances to apply attributes to.

Will only set/create Validator is the passed UIComponent's parent is null, signifying that it wasn't restored from an existing tree.

Field Summary

Fields inherited from class DelegatingMetaTagHandler

delegateFactory

Modifier and Type	Field	Description
protected TagHandlerDelegateFactory	delegateFactory	Class that defines methods relating to helping tag handler instances.

Fields inherited from class TagHandler

nextHandler, tag, tagId

Modifier and Type	Field	Description
protected final FaceletHandler	nextHandler	A reference to the FaceletHandler that represents the first nested child of this TagHandler instance.
protected final Tag	tag	A reference to the Tag instance corresponding to this TagHandler instance.
protected final String	tagId	See TagConfig.getTagId().

Constructor Summary

Constructors

Constructor	Description
ValidatorHandler(ValidatorConfig config)	Construct this instance around the configuration information in argument config

Method Summary

Modifier and Type	Method	Description
protected TagHandlerDelegate	getTagHandlerDelegate()	Return the implementation specific delegate instance that provides the bulk of the work for this handler instance.
ValidatorConfig	getValidatorConfig()	Return the TagConfig subclass used to configure this handler instance.
String	getValidatorId(FaceletContext ctx)	Retrieve the id of the validator that is to be created and added to the parent EditableValueHolder.

Methods inherited from class FaceletsAttachedObjectHandler

applyAttachedObject, getAttachedObjectHandlerHelper, getFor

Modifier and Type	Method	Description
final void	applyAttachedObject(FacesContext ctx, UIComponent parent)	Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this class to the argument parent.
protected final AttachedObjectHandler	getAttachedObjectHandlerHelper()	Return the underlying handler for this tag handler instance.
final String	getFor()	Return the value of the "for" attribute.

Methods inherited from class DelegatingMetaTagHandler

apply, applyNextHandler, createMetaRuleset, getBinding, getTag, getTagAttribute, getTagId, isDisabled, setAttributes

Modifier and Type	Method	Description
void	apply(FaceletContext ctx, UIComponent parent)	The default implementation simply calls through to TagHandlerDelegate.apply(FaceletContext, UIComponent).
void	applyNextHandler(FaceletContext ctx, UIComponent c)	Invoke the apply() method on this instance's TagHandler.nextHandler.
protected MetaRuleset	createMetaRuleset(Class type)	The default implementation simply calls through to TagHandlerDelegate.createMetaRuleset(Class) and returns the result.
TagAttribute	getBinding()	Return the "binding" attribute.
Tag	getTag()	Return a reference to the Tag instance corresponding to this TagHandler instance.
TagAttribute	getTagAttribute(String localName)	Return the named attribute from the tag attributes.
String	getTagId()	Return the tag id from the TagConfig used to instantiate this handler.
boolean	isDisabled(FaceletContext ctx)	Returns the value of the "disabled" attribute.
void	setAttributes(FaceletContext ctx, Object instance)	Invoking/extending this method will cause the results of the created MetaRuleset to auto-wire state to the passed instance.

Methods inherited from class TagHandler

getAttribute, getRequiredAttribute, toString

Modifier and Type	Method	Description
protected final TagAttribute	getAttribute(String localName)	Utility method for fetching the appropriate TagAttribute
protected final TagAttribute	getRequiredAttribute(String localName)	Utility method for fetching a required TagAttribute
String	toString()

Methods inherited from class Object

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

Constructor Details

ValidatorHandler

public ValidatorHandler(ValidatorConfig config)

Construct this instance around the configuration information in argument config

Parameters:

config - the TagConfig subclass for this kind of attached object.

Method Details

getTagHandlerDelegate

protected TagHandlerDelegate getTagHandlerDelegate()

Return the implementation specific delegate instance that provides the bulk of the work for this handler instance.

Specified by:

getTagHandlerDelegate in class DelegatingMetaTagHandler

Returns:

the implementation specific delegate instance

getValidatorId

public String getValidatorId(FaceletContext ctx)

Retrieve the id of the validator that is to be created and added to the parent EditableValueHolder. All subclasses should override this method because it is important for Facelets to have a unique way of identifying the validators that are added to this EditableValueHolder and allows exclusions to work properly. An exclusion is a validator declaration that has the attribute "disabled" which resolves to false, instructing Facelets not to register a default validator with the same id.

Parameters:

ctx - the FaceletContext for this Facelet

Returns:

the validator-id

getValidatorConfig

public ValidatorConfig getValidatorConfig()

Return the TagConfig subclass used to configure this handler instance.

Returns:

the TagConfig subclass used to configure this handler instance.