com.github.restup.annotations.filter

Annotation Type Validation

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Validation

Annotates a validation method

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	path Path(s) for which the validation will apply

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	onCreate If true, the method will execute on create.
boolean	onUpdate If true, the method will execute on update.
boolean	required On create, indicates whether the validation must execute if the path is absent.
boolean	skipOnErrors If Errors exist for the request and true, the validation may be skipped.

Element Detail

path

public abstract String[] path

Path(s) for which the validation will apply

required

public abstract boolean required

On create, indicates whether the validation must execute if the path is absent. For example if required is false and the path is absent, the validation may be skipped. On the other hand, if true and the path is absent, the validate must still execute.

Default:

true

onCreate

public abstract boolean onCreate

If true, the method will execute on create. Otherwise will not execute on create.

Default:

true

onUpdate

public abstract boolean onUpdate

If true, the method will execute on update. Otherwise will not execute on update.

Default:

true

skipOnErrors

public abstract boolean skipOnErrors

If Errors exist for the request and true, the validation may be skipped. If false, the validation will execute regardless of errors. If a validation incurs expensive or time consuming processing it may be useful to set skipOnErrors to true.

Default:

false