Module org.omnifaces

Package org.omnifaces.component.validator

Class ValidatorFamily

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.validator.ValidatorFamily

All Implemented Interfaces:

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

Direct Known Subclasses:

ValidateMultipleFields

public abstract class ValidatorFamily
extends UIComponentBase

Base class which is to be shared between all components of the Validator family.

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY	The standard component family.

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
ValidatorFamily()

Method Summary

Modifier and Type	Method	Description
void	encodeChildren(FacesContext context)	Calls validateHierarchy(FacesContext).
String	getFamily()	Returns COMPONENT_FAMILY.
boolean	getRendersChildren()	Returns true.
void	processDecodes(FacesContext context)	Calls validateHierarchy(FacesContext).
void	processUpdates(FacesContext context)	Does nothing.
void	processValidators(FacesContext context)	Calls validateComponents(FacesContext).
protected abstract void	validateComponents(FacesContext context)	Perform the actual validation.
protected void	validateHierarchy()	Deprecated, for removal: This API element is subject to removal in a future version. Use validateHierarchy(FacesContext) instead.
protected abstract void	validateHierarchy(FacesContext context)	Validate our own component hierarchy.

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, 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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family.

See Also:

Constant Field Values

Constructor Detail

ValidatorFamily

public ValidatorFamily()

Method Detail

getFamily

public String getFamily()

Returns COMPONENT_FAMILY.

Specified by:

getFamily in class UIComponent

getRendersChildren

public boolean getRendersChildren()

Returns true.

Overrides:

getRendersChildren in class UIComponentBase

processDecodes

public void processDecodes(FacesContext context)

Calls validateHierarchy(FacesContext).

Overrides:

processDecodes in class UIComponentBase

processValidators

public void processValidators(FacesContext context)

Calls validateComponents(FacesContext).

Overrides:

processValidators in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)

Does nothing.

Overrides:

processUpdates in class UIComponentBase

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Calls validateHierarchy(FacesContext).

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

validateHierarchy

@Deprecated(since="4.6",
            forRemoval=true)
protected void validateHierarchy()

Deprecated, for removal: This API element is subject to removal in a future version.

Use validateHierarchy(FacesContext) instead.

Validate our own component hierarchy.

Throws:

IllegalStateException - When component hierarchy is wrong.

validateHierarchy

protected abstract void validateHierarchy(FacesContext context)

Validate our own component hierarchy.

Parameters:

context - The faces context to work with.

Throws:

IllegalStateException - When component hierarchy is wrong.

Since:

4.6

validateComponents

protected abstract void validateComponents(FacesContext context)

Perform the actual validation.

Parameters:

context - The faces context to work with.