net.sf.oval.constraint
Annotation Type NotEqualToField


@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,PARAMETER,METHOD})
@Constraint(checkWith=NotEqualToFieldCheck.class)
public @interface NotEqualToField

Check if value does not equal the value of the referenced field.

Note: This constraint is also satisfied when the value to validate is null, therefore you might also need to specified @NotNull

Author:
Sebastian Thomschke

Required Element Summary
 String value
          name of the field
 
Optional Element Summary
 ConstraintTarget[] appliesTo
          In case the constraint is declared for an array, collection or map this controls how the constraint is applied to it and it's child objects.
 Class<?> declaringClass
          The class in which the field is declared.
 String errorCode
          error code passed to the ConstraintViolation object
 String message
          message to be used for the ContraintsViolatedException
 String[] profiles
          The associated constraint profiles.
 int severity
          severity passed to the ConstraintViolation object
 String target
          An expression to specify where in the object graph relative from this object the expression should be applied.
 boolean useGetter
          if set to true the field's value will be retrieved via the corresponding getter method instead of reflection
 String when
          Formula returning true if this constraint shall be evaluated and false if it shall be ignored for the current validation.
 

Element Detail

value

public abstract String value
name of the field

appliesTo

public abstract ConstraintTarget[] appliesTo

In case the constraint is declared for an array, collection or map this controls how the constraint is applied to it and it's child objects.

Default: ConstraintTarget.CONTAINER

Note: This setting is ignored for object types other than array, map and collection.

Default:
CONTAINER

declaringClass

public abstract Class<?> declaringClass
The class in which the field is declared. If omitted the current class and it's super classes are searched for a field with the given name. The default value Void.class means the current class.

Default:
java.lang.Void.class

errorCode

public abstract String errorCode
error code passed to the ConstraintViolation object

Default:
"net.sf.oval.constraint.NotEqualToField"

message

public abstract String message
message to be used for the ContraintsViolatedException

See Also:
ConstraintViolation
Default:
"net.sf.oval.constraint.NotEqualToField.violated"

profiles

public abstract String[] profiles
The associated constraint profiles.

Default:
{}

severity

public abstract int severity
severity passed to the ConstraintViolation object

Default:
0

target

public abstract String target
An expression to specify where in the object graph relative from this object the expression should be applied.

Examples:

  • "owner" would apply this constraint to the current object's property owner
  • "owner.id" would apply this constraint to the current object's owner's property id
  • "jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied.

    Default:
    ""

  • useGetter

    public abstract boolean useGetter
    if set to true the field's value will be retrieved via the corresponding getter method instead of reflection

    Default:
    false

    when

    public abstract String when
    Formula returning true if this constraint shall be evaluated and false if it shall be ignored for the current validation.

    Important: The formula must be prefixed with the name of the scripting language that is used. E.g. groovy:_this.amount > 10

    Available context variables are:
    _this -> the validated bean
    _value -> the value to validate (e.g. the field value, parameter value, method return value, or the validated bean for object level constraints)

    Default:
    ""


    Copyright © 2005–2015 The OVal Development Team. All rights reserved.