Package org.kiwiproject.validation

Annotation Type FilePath

@Documented
@Constraint(validatedBy=FilePathValidator.class)
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
public @interface FilePath

The annotated element must point to an existing file.

By default does not permit null values. If the element being validated allows null values, you can set allowNull() to true.

Examples:

 @FilePath
  private String location;
 

 @FilePath(allowNull = true)
  public String getLocation() { return this.location; }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	allowNull	Whether to consider null as valid.
Class<?>[]	groups
String	message
Class<? extends javax.validation.Payload>[]	payload

Element Detail

message

String message

Default:

"{org.kiwiproject.validation.FilePath.message}"

groups

Class<?>[] groups

Default:

{}

payload

Class<? extends javax.validation.Payload>[] payload

Default:

{}

allowNull

boolean allowNull

Whether to consider null as valid. The default is false.

Returns:

true to consider null as valid

Default:

false