org.hippoecm.frontend.validation

Class Violation

java.lang.Object

org.hippoecm.frontend.validation.Violation

All Implemented Interfaces:

Serializable, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable

public final class Violation
extends Object
implements org.apache.wicket.model.IDetachable

Validation constraint violation. Provides the list of ModelPaths that led up to the violation and three parameters that can be used to generate a translated description of the violation. These parameters are a message key, an array of parameters for value substitution in the translation and a resourceBundleClass to specify the location of the resource bundle.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Violation(Class<?> resourceBundleClass, String messageKey, Object[] parameters, Set<ModelPath> fieldPaths) Deprecated. use the Violation(Set, IModel) constructor instead.
Violation(Set<ModelPath> paths, org.apache.wicket.model.IModel<String> messageModel) Create a new violation with the specified message.

Method Summary

Modifier and Type	Method and Description
void	detach()
Set<ModelPath>	getDependentPaths()
org.apache.wicket.model.IModel<String>	getMessage()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Violation

@Deprecated
public Violation(Class<?> resourceBundleClass,
                              String messageKey,
                              Object[] parameters,
                              Set<ModelPath> fieldPaths)

Deprecated. use the Violation(Set, IModel) constructor instead.

Create a new violation whose resource bundle is looked up relative to the resourceBundleClass parameter. This constructor has been deprecated. Validators should provide their own message translation.

Parameters:

resourceBundleClass - Resource bundle will be looked up relative to this class

messageKey - The key used for translation

parameters - Optional parameters for value substitution in translations

fieldPaths - List of ModelPaths that led up to the violation

Violation

public Violation(Set<ModelPath> paths,
                 org.apache.wicket.model.IModel<String> messageModel)

Create a new violation with the specified message.

Parameters:

paths - list of ModelPaths that led up to the violation

messageModel - a model of the message to be shown to the user

Method Detail

getMessage

public org.apache.wicket.model.IModel<String> getMessage()

getDependentPaths

public Set<ModelPath> getDependentPaths()

toString

public String toString()

Overrides:

toString in class Object

detach

public void detach()

Specified by:

detach in interface org.apache.wicket.model.IDetachable