de.carne.util.validation

Class PathValidator

java.lang.Object

de.carne.util.validation.PathValidator

public final class PathValidator
extends java.lang.Object

This class provides validation function for Path objects and the like.

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	isDirectoryPath(java.lang.String input, MessageFormatter message) Make sure input is a directory path.
static java.nio.file.Path	isPath(java.nio.file.Path basePath, java.lang.String input, MessageFormatter message) Make sure input is a valid relative path.
static java.nio.file.Path	isPath(java.lang.String input, MessageFormatter message) Make sure input is a valid path.
static java.nio.file.Path	isReadablePath(java.lang.String input, MessageFormatter message) Make sure input is a readable path.
static java.nio.file.Path	isRegularFilePath(java.lang.String input, MessageFormatter message) Make sure input is a file path.
static java.nio.file.Path	isWritablePath(java.lang.String input, MessageFormatter message) Make sure input is a writable path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isPath

public static java.nio.file.Path isPath(java.lang.String input,
                                        MessageFormatter message)
                                 throws ValidationException

Make sure input is a valid path.

Parameters:

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

isPath

public static java.nio.file.Path isPath(java.nio.file.Path basePath,
                                        java.lang.String input,
                                        MessageFormatter message)
                                 throws ValidationException

Make sure input is a valid relative path.

Parameters:

basePath - The base path to validate the input against.

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

isRegularFilePath

public static java.nio.file.Path isRegularFilePath(java.lang.String input,
                                                   MessageFormatter message)
                                            throws ValidationException

Make sure input is a file path.

Parameters:

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

See Also:

Files.isRegularFile(Path, java.nio.file.LinkOption...)

isDirectoryPath

public static java.nio.file.Path isDirectoryPath(java.lang.String input,
                                                 MessageFormatter message)
                                          throws ValidationException

Make sure input is a directory path.

Parameters:

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

See Also:

Files.isReadable(Path)

isReadablePath

public static java.nio.file.Path isReadablePath(java.lang.String input,
                                                MessageFormatter message)
                                         throws ValidationException

Make sure input is a readable path.

Parameters:

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

See Also:

Files.isReadable(Path)

isWritablePath

public static java.nio.file.Path isWritablePath(java.lang.String input,
                                                MessageFormatter message)
                                         throws ValidationException

Make sure input is a writable path.

Parameters:

input - The input to validate.

message - The exception message to use if the input is invalid.

Returns:

The validated Path object.

Throws:

ValidationException - if the input is invalid.

See Also:

Files.isWritable(Path)