Module com.github.cowwoc.requirements10.java

Package com.github.cowwoc.requirements10.java.validator

Interface PathValidator

All Superinterfaces:

ObjectComponent<PathValidator,Path>, ValidatorComponent<PathValidator,Path>

public interface PathValidator
extends ValidatorComponent<PathValidator,Path>, ObjectComponent<PathValidator,Path>

Validates the state of a Path.

Method Summary

Modifier and Type	Method	Description
PathValidator	contains(Path expected)	Ensures that the path contains another path.
PathValidator	contains(Path expected, String name)	Ensures that the path contains another path.
PathValidator	exists()	Ensures that the path exists.
PathValidator	isAbsolute()	Ensures that the path is absolute.
PathValidator	isDirectory(LinkOption... options)	Ensures that the path is a directory.
PathValidator	isRegularFile(LinkOption... options)	Ensures that the path is a regular file.
PathValidator	isRelative()	Ensures that the path is relative.

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ObjectComponent

getValue, isEqualTo, isEqualTo, isInstanceOf, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotInstanceOf, isNotInstanceOf, isNotNull, isNull, isReferenceEqualTo, isReferenceNotEqualTo

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ValidatorComponent

and, elseGetFailures, elseThrow, getContext, getContextAsString, getName, getValueOrDefault, validationFailed, withContext

Method Details

exists

PathValidator exists()

Ensures that the path exists.

The state of the path may change immediately upon returning from this method. Consequently, special care should be taken when using this method in security-sensitive applications.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the path does not exist

isAbsolute

PathValidator isAbsolute()

Ensures that the path is absolute.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the path is relative

isRelative

PathValidator isRelative()

Ensures that the path is relative.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if value refers to an absolute path

isDirectory

PathValidator isDirectory(LinkOption... options)
                   throws IOException

Ensures that the path is a directory.

Parameters:

options - options indicating how symbolic links are handled

Returns:

this

Throws:

NullPointerException - if the value or options are null

IllegalArgumentException - if the path does not exist or is not a directory

IOException - if an I/O error occurs while reading the file attributes (e.g., the file does not exist or the user lacks the required permissions)

isRegularFile

PathValidator isRegularFile(LinkOption... options)
                     throws IOException

Ensures that the path is a regular file.

Parameters:

options - options indicating how symbolic links are handled

Returns:

this

Throws:

NullPointerException - if the value or options are null

IllegalArgumentException - if the path does not exist or is not a file

IOException - if an I/O error occurs while reading the file attributes (e.g., the file does not exist or the user lacks the required permissions)

contains

PathValidator contains(Path expected)

Ensures that the path contains another path.

Parameters:

expected - the other path

Returns:

this

Throws:

NullPointerException - if the value or expected is null

IllegalArgumentException - if the path does not contain expected

contains

PathValidator contains(Path expected,
 String name)

Ensures that the path contains another path.

Parameters:

expected - the other path

name - the name of the expected value

Returns:

this

Throws:

NullPointerException - if the value or expected is null

IllegalArgumentException - if the path does not contain expected