org.apache.wicket.validation

Class CompoundValidator<T>

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.validation.CompoundValidator<T>

Type Parameters:

T - type of validatable

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable, IValidator<T>

public class CompoundValidator<T>
extends Behavior
implements IValidator<T>

A compound IValidator. Once an error is reported against the IValidatable being checked, the rest of the validator chain is ignored.

Since:

1.2.6

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompoundValidator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
CompoundValidator<T>	add(IValidator<T> validator) Adds an IValidator to the chain of validators.
void	afterRender(Component component) Called when a component that has this behavior coupled was rendered.
void	beforeRender(Component component) Called when a component is about to render.
void	bind(Component component) Bind this handler to the given component.
void	detach(Component component) Allows the behavior to detach any state it has attached during request processing.
boolean	getStatelessHint(Component component) This method returns false if the behavior generates a callback url (for example ajax behaviors)
List<IValidator<T>>	getValidators() Gets an unmodifiable list of the registered validators.
void	onComponentTag(Component component, ComponentTag tag) Called any time a component that has this behavior registered is rendering the component tag.
void	onConfigure(Component component) Called immediately after the onConfigure method in a component.
void	onEvent(Component component, IEvent<?> event) Called to notify the behavior about any events sent to the component
void	onException(Component component, RuntimeException exception) In case an unexpected exception happened anywhere between Behavior.onComponentTag(org.apache.wicket.Component, org.apache.wicket.markup.ComponentTag) and Behavior.afterRender(org.apache.wicket.Component), onException() will be called for any behavior.
void	onRemove(Component component) Called to notify that the component is being removed from its parent
void	renderHead(Component component, IHeaderResponse response) Render to the web response whatever the component wants to contribute to the head section.
void	unbind(Component component) Notifies the behavior it is removed from the specified component
void	validate(IValidatable<T> validatable) Validates the IValidatable instance.

Methods inherited from class org.apache.wicket.behavior.Behavior

canCallListenerInterface, isEnabled, isTemporary

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundValidator

public CompoundValidator()

Constructor.

Method Detail

add

public final CompoundValidator<T> add(IValidator<T> validator)

Adds an IValidator to the chain of validators.

Parameters:

validator - an IValidator to be added

Returns:

this ValidationError for chaining purposes

validate

public final void validate(IValidatable<T> validatable)

Description copied from interface: IValidator

Validates the IValidatable instance. Validation errors should be reported using the IValidatable.error(IValidationError) method.

Specified by:

validate in interface IValidator<T>

Parameters:

validatable - the IValidatable instance being validated

See Also:

IValidator.validate(IValidatable)

getValidators

public final List<IValidator<T>> getValidators()

Gets an unmodifiable list of the registered validators.

Returns:

unmodifiable list of delegate IValidators inside this one

beforeRender

public void beforeRender(Component component)

Description copied from class: Behavior

Called when a component is about to render.

Overrides:

beforeRender in class Behavior

Parameters:

component - the component that has this behavior coupled

afterRender

public void afterRender(Component component)

Description copied from class: Behavior

Called when a component that has this behavior coupled was rendered.

Overrides:

afterRender in class Behavior

Parameters:

component - the component that has this behavior coupled

bind

public void bind(Component component)

Description copied from class: Behavior

Bind this handler to the given component. This method is called by the host component immediately after this behavior is added to it. This method is useful if you need to do initialization based on the component it is attached and you can't wait to do it at render time. Keep in mind that if you decide to keep a reference to the host component, it is not thread safe anymore, and should thus only be used in situations where you do not reuse the behavior for multiple components.

Overrides:

bind in class Behavior

Parameters:

component - the component to bind to

unbind

public void unbind(Component component)

Description copied from class: Behavior

Notifies the behavior it is removed from the specified component

Overrides:

unbind in class Behavior

Parameters:

component - the component this behavior is unbound from

detach

public void detach(Component component)

Description copied from class: Behavior

Allows the behavior to detach any state it has attached during request processing.

Overrides:

detach in class Behavior

Parameters:

component - the component that initiates the detachment of this behavior

onException

public void onException(Component component,
               RuntimeException exception)

Description copied from class: Behavior

In case an unexpected exception happened anywhere between Behavior.onComponentTag(org.apache.wicket.Component, org.apache.wicket.markup.ComponentTag) and Behavior.afterRender(org.apache.wicket.Component), onException() will be called for any behavior. Typically, if you clean up resources in Behavior.afterRender(Component), you should do the same in the implementation of this method.

Overrides:

onException in class Behavior

Parameters:

component - the component that has a reference to this behavior and during which processing the exception occurred

exception - the unexpected exception

getStatelessHint

public boolean getStatelessHint(Component component)

Description copied from class: Behavior

This method returns false if the behavior generates a callback url (for example ajax behaviors)

Overrides:

getStatelessHint in class Behavior

Parameters:

component - the component that has this behavior coupled.

Returns:

boolean true or false.

onComponentTag

public void onComponentTag(Component component,
                  ComponentTag tag)

Description copied from class: Behavior

Called any time a component that has this behavior registered is rendering the component tag.

Overrides:

onComponentTag in class Behavior

Parameters:

component - the component that renders this tag currently

tag - the tag that is rendered

renderHead

public void renderHead(Component component,
              IHeaderResponse response)

Description copied from class: Behavior

Render to the web response whatever the component wants to contribute to the head section.

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class Behavior

Parameters:

component - component which is contributing to the response. This parameter is here to give the component as the context for component-awares implementing this interface

response - Response object

onConfigure

public void onConfigure(Component component)

Description copied from class: Behavior

Called immediately after the onConfigure method in a component. Since this is before the rendering cycle has begun, the behavior can modify the configuration of the component (i.e. setVisible(false))

Overrides:

onConfigure in class Behavior

Parameters:

component - the component being configured

onEvent

public void onEvent(Component component,
           IEvent<?> event)

Description copied from class: Behavior

Called to notify the behavior about any events sent to the component

Specified by:

onEvent in interface IComponentAwareEventSink

Overrides:

onEvent in class Behavior

Parameters:

component - component that owns this sink. For example, if the implementation of this interface is a Behavior then component parameter will contain the component to which the behavior is attached.

See Also:

IComponentAwareEventSink.onEvent(org.apache.wicket.Component, org.apache.wicket.event.IEvent)

onRemove

public void onRemove(Component component)

Description copied from class: Behavior

Called to notify that the component is being removed from its parent

Overrides:

onRemove in class Behavior

Parameters:

component - the removed component