info.magnolia.resourceloader.util

Class PredicatedResourceVisitor

java.lang.Object

info.magnolia.resourceloader.util.PredicatedResourceVisitor

All Implemented Interfaces:

ResourceVisitor

Direct Known Subclasses:

FileResourceCollectorVisitor

public class PredicatedResourceVisitor
extends Object
implements ResourceVisitor

A ResourceVisitor constructed with Predicates and a Function to determine its behavior.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PredicatedResourceVisitor(com.google.common.base.Predicate<Resource> visitDirectory, com.google.common.base.Predicate<Resource> applyToDirectory, com.google.common.base.Predicate<Resource> applyToFile, com.google.common.base.Function<Resource,Void> function)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.Function<Resource,Void>	getFunction() Can be useful to e.g.
static PredicatedResourceVisitor	onAllMatchingFiles(com.google.common.base.Predicate<Resource> applyToFile, com.google.common.base.Function<Resource,Void> function) Traverses all directories, and applies the given Function to all files, according to applyToFile.
boolean	visitDirectory(Resource resource) Determines if we should visit this directory resource.
void	visitFile(Resource resource) Implementations can decide to do anything with the file; note that ResourceVisitor.visitDirectory(Resource) is NOT called for files.
static PredicatedResourceVisitor	with(com.google.common.base.Function<Resource,Void> function) Visits everything and applies the given Function to everything.
static PredicatedResourceVisitor	with(com.google.common.base.Predicate<Resource> visitAndApply, com.google.common.base.Function<Resource,Void> function) Visits according to the given visitAndApply predicate and applies the given Function according to visitAndApply.
static PredicatedResourceVisitor	with(com.google.common.base.Predicate<Resource> visitDirectory, com.google.common.base.Predicate<Resource> applyFunction, com.google.common.base.Function<Resource,Void> function) Visits according to the given visitDirectory predicate and applies the given Function according to applyFunction.
static PredicatedResourceVisitor	with(com.google.common.base.Predicate<Resource> visitDirectory, com.google.common.base.Predicate<Resource> applyToDirectory, com.google.common.base.Predicate<Resource> applyToFile, com.google.common.base.Function<Resource,Void> function) Visits according to the given visitDirectory predicate and applies the given Function according to applyToDirectory and applyToFile depending on the resource's type.

Methods inherited from class java.lang.Object

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

Constructor Detail

PredicatedResourceVisitor

protected PredicatedResourceVisitor(com.google.common.base.Predicate<Resource> visitDirectory,
                                    com.google.common.base.Predicate<Resource> applyToDirectory,
                                    com.google.common.base.Predicate<Resource> applyToFile,
                                    com.google.common.base.Function<Resource,Void> function)

Method Detail

with

public static PredicatedResourceVisitor with(com.google.common.base.Function<Resource,Void> function)

Visits everything and applies the given Function to everything.

See Also:

which provides a couple of helpful predicates and functions to use with Resource., VoidFunction

with

public static PredicatedResourceVisitor with(com.google.common.base.Predicate<Resource> visitAndApply,
                                             com.google.common.base.Function<Resource,Void> function)

Visits according to the given visitAndApply predicate and applies the given Function according to visitAndApply.

See Also:

which provides a couple of helpful predicates and functions to use with Resource., TODO: visitAndApply is used for both visiting and applying, so e.g pattern /foo/.*\.text won't match anything because "/foo" doesn't match the expression

with

public static PredicatedResourceVisitor with(com.google.common.base.Predicate<Resource> visitDirectory,
                                             com.google.common.base.Predicate<Resource> applyFunction,
                                             com.google.common.base.Function<Resource,Void> function)

Visits according to the given visitDirectory predicate and applies the given Function according to applyFunction.

See Also:

which provides a couple of helpful predicates and functions to use with Resource., VoidFunction

with

public static PredicatedResourceVisitor with(com.google.common.base.Predicate<Resource> visitDirectory,
                                             com.google.common.base.Predicate<Resource> applyToDirectory,
                                             com.google.common.base.Predicate<Resource> applyToFile,
                                             com.google.common.base.Function<Resource,Void> function)

Visits according to the given visitDirectory predicate and applies the given Function according to applyToDirectory and applyToFile depending on the resource's type.

See Also:

which provides a couple of helpful predicates and functions to use with Resource., VoidFunction

onAllMatchingFiles

public static PredicatedResourceVisitor onAllMatchingFiles(com.google.common.base.Predicate<Resource> applyToFile,
                                                           com.google.common.base.Function<Resource,Void> function)

Traverses all directories, and applies the given Function to all files, according to applyToFile. Does not apply the function to directory resources.

See Also:

which provides a couple of helpful predicates and functions to use with Resource., VoidFunction

visitDirectory

public boolean visitDirectory(Resource resource)

Description copied from interface: ResourceVisitor

Determines if we should visit this directory resource. Implementations can decide to do anything with the directory as well; note that ResourceVisitor.visitFile(Resource) is NOT called for directories.

Specified by:

visitDirectory in interface ResourceVisitor

Returns:

true if we should visit children (directories and files) of the given resource.

visitFile

public void visitFile(Resource resource)

Description copied from interface: ResourceVisitor

Implementations can decide to do anything with the file; note that ResourceVisitor.visitDirectory(Resource) is NOT called for files.

Specified by:

visitFile in interface ResourceVisitor

getFunction

protected com.google.common.base.Function<Resource,Void> getFunction()

Can be useful to e.g. retrieve resources collected by the function.