Package edu.wisc.library.ocfl.core.path.constraint

Class PathConstraintProcessor

java.lang.Object

edu.wisc.library.ocfl.core.path.constraint.PathConstraintProcessor

public class PathConstraintProcessor
extends Object

A PathConstraintProcessor is used to apply a preconfigured set of constraints to a given path. If the path fails to meet a constraint, a PathConstraintException is thrown.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathConstraintProcessor.Builder	Use this to construct a new PathConstraintProcessor

Constructor Summary

Constructors

Constructor	Description
PathConstraintProcessor(List<PathConstraint> pathConstraints, List<FileNameConstraint> fileNameConstraints, List<PathCharConstraint> charConstraints)	Constructs a new PathConstraintProcessor.

Method Summary

Modifier and Type	Method	Description
PathConstraintProcessor	appendCharConstraint(PathCharConstraint charConstraint)	Adds a new character constraint to the end of the list of character constraints
PathConstraintProcessor	appendFileNameConstraint(FileNameConstraint fileNameConstraint)	Adds a new filename constraint to the end of the list of filename constraints
PathConstraintProcessor	appendPathConstraint(PathConstraint pathConstraint)	Adds a new path constraint to the end of the list of path constraints
String	apply(String path)	Applies all of the configured constraints on the path.
static PathConstraintProcessor.Builder	builder()	Use this to construct a new PathConstraintProcessor
PathConstraintProcessor	prependCharConstraint(PathCharConstraint charConstraint)	Adds a new character constraint to the beginning of the list of character constraints
PathConstraintProcessor	prependFileNameConstraint(FileNameConstraint fileNameConstraint)	Adds a new filename constraint to the beginning of the list of filename constraints
PathConstraintProcessor	prependPathConstraint(PathConstraint pathConstraint)	Adds a new path constraint to the beginning of the list of path constraints

Methods inherited from class java.lang.Object

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

Constructor Detail

PathConstraintProcessor

public PathConstraintProcessor(List<PathConstraint> pathConstraints,
                               List<FileNameConstraint> fileNameConstraints,
                               List<PathCharConstraint> charConstraints)

Constructs a new PathConstraintProcessor. The builder PathConstraintProcessor.Builder may also be used.

Parameters:

pathConstraints - list of path constraints

fileNameConstraints - list of filename constraints

charConstraints - list of character constraints

Method Detail

builder

public static PathConstraintProcessor.Builder builder()

Use this to construct a new PathConstraintProcessor

Returns:

builder

apply

public String apply(String path)

Applies all of the configured constraints on the path. If one of them fails, then a PathConstraintException is thrown.

Parameters:

path - the path to apply constraints to

Returns:

the input path

Throws:

PathConstraintException - when a constraint fails

prependPathConstraint

public PathConstraintProcessor prependPathConstraint(PathConstraint pathConstraint)

Adds a new path constraint to the beginning of the list of path constraints

Parameters:

pathConstraint - constraint to add

Returns:

this

prependFileNameConstraint

public PathConstraintProcessor prependFileNameConstraint(FileNameConstraint fileNameConstraint)

Adds a new filename constraint to the beginning of the list of filename constraints

Parameters:

fileNameConstraint - constraint to add

Returns:

this

prependCharConstraint

public PathConstraintProcessor prependCharConstraint(PathCharConstraint charConstraint)

Adds a new character constraint to the beginning of the list of character constraints

Parameters:

charConstraint - constraint to add

Returns:

this

appendPathConstraint

public PathConstraintProcessor appendPathConstraint(PathConstraint pathConstraint)

Adds a new path constraint to the end of the list of path constraints

Parameters:

pathConstraint - constraint to add

Returns:

this

appendFileNameConstraint

public PathConstraintProcessor appendFileNameConstraint(FileNameConstraint fileNameConstraint)

Adds a new filename constraint to the end of the list of filename constraints

Parameters:

fileNameConstraint - constraint to add

Returns:

this

appendCharConstraint

public PathConstraintProcessor appendCharConstraint(PathCharConstraint charConstraint)

Adds a new character constraint to the end of the list of character constraints

Parameters:

charConstraint - constraint to add

Returns:

this