org.hippoecm.frontend.validation

Class Violation

java.lang.Object

org.hippoecm.frontend.validation.Violation

All Implemented Interfaces:

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

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) Create a new violation whose resource bundle is looked up relative to the resourceBundleClass parameter.
Violation(Set<ModelPath> fieldPaths, String messageKey, Object[] parameters) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	detach()
Set<ModelPath>	getDependentPaths()
String	getMessageKey()
Object[]	getParameters()
Class<?>	getResourceBundleClass()
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(Set<ModelPath> fieldPaths,
                    String messageKey,
                    Object[] parameters)

Deprecated.

Create a new violation whose resource bundle is looked up relative to the class that uses the violation instead of the class that creates the violation. Since this can easily lead to various bugs and difficult extensibility this constructor has been deprecated in favor of Violation(Set<ModelPath> fieldPaths, Class<?> resourceBundleClass, String messageKey, Object[] parameters)

Parameters:

fieldPaths - List of ModelPaths that led up to the violation

messageKey - The key used for translation

parameters - Optional parameters for value substitution in translations

Violation

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

Create a new violation whose resource bundle is looked up relative to the resourceBundleClass parameter.

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

Method Detail

getMessageKey

public String getMessageKey()

getParameters

public Object[] getParameters()

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

getResourceBundleClass

public Class<?> getResourceBundleClass()