org.bitbucket.cowwoc.requirements

Interface PathRequirements

All Superinterfaces:

Isolatable<PathRequirements>, org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<PathRequirements,Path>, Verifier

public interface PathRequirements
extends org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<PathRequirements,Path>, Isolatable<PathRequirements>

Verifies requirements of a Path parameter.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
PathRequirements	exists() Ensures that the parameter exists.
PathRequirements	isAbsolute() Ensures that the parameter is absolute.
PathRequirements	isDirectory(LinkOption... options) Ensures that the parameter refers to a directory.
PathRequirements	isRegularFile(LinkOption... options) Ensures that the parameter refers to a regular file.
PathRequirements	isRelative() Ensures that the parameter is relative.

Methods inherited from interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

addContext, isEqualTo, isEqualTo, isIn, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotNull, isNull, withContext, withException

Methods inherited from interface org.bitbucket.cowwoc.requirements.Isolatable

isolate

Method Detail

exists

PathRequirements exists()
                 throws IllegalArgumentException

Ensures that the parameter exists.

Note that the result of this method is immediately outdated. If this method indicates the file exists then there is no guarantee that a subsequence access will succeed. Care should be taken when using this method in security sensitive applications.

Returns:

this

Throws:

IllegalArgumentException - if parameter refers to a non-existent path

isAbsolute

PathRequirements isAbsolute()
                     throws IllegalArgumentException

Ensures that the parameter is absolute.

Returns:

this

Throws:

IllegalArgumentException - if parameter refers to an absolute path

isDirectory

PathRequirements isDirectory(LinkOption... options)
                      throws IllegalArgumentException,
                             IOException

Ensures that the parameter refers to a directory.

Parameters:

options - options indicating how symbolic links are handled

Returns:

this

Throws:

IllegalArgumentException - if parameter refers to a non-existent or a non-directory path

IOException - if an I/O error occurs while reading the file attributes

isRegularFile

PathRequirements isRegularFile(LinkOption... options)
                        throws IllegalArgumentException,
                               IOException

Ensures that the parameter refers to a regular file.

Parameters:

options - options indicating how symbolic links are handled

Returns:

this

Throws:

IllegalArgumentException - if parameter refers to a non-existent or a non-file path

IOException - if an I/O error occurs while reading the file attributes

isRelative

PathRequirements isRelative()
                     throws IllegalArgumentException

Ensures that the parameter is relative.

Returns:

this

Throws:

IllegalArgumentException - if parameter refers to an absolute path