org.ocpsoft.rewrite.config

Class Filesystem

java.lang.Object

org.ocpsoft.rewrite.config.Filesystem

All Implemented Interfaces:

Condition, Parameterized

public class Filesystem
extends Object
implements Condition, Parameterized

A Condition responsible for determining existence of File paths on the host file-system.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
static Filesystem	directoryExists(File resource) Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a directory.
boolean	evaluate(Rewrite event, EvaluationContext context) Evaluate this condition against the given Rewrite event.
static Filesystem	fileExists(File resource) Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a normal file.
ParameterizedPatternParser	getExpression() Get the ParameterizedPattern of this Filesystem.
Set<String>	getRequiredParameterNames() Get all required Parameter names for this Parameterized instance.
void	setParameterStore(ParameterStore store) Initialize this Parameterized instance with the global ParameterStore.

Methods inherited from class java.lang.Object

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

Method Detail

evaluate

public boolean evaluate(Rewrite event,
               EvaluationContext context)

Description copied from interface: Condition

Evaluate this condition against the given Rewrite event. If this condition does not apply to the given event, it must return false. If the condition applies and is satisfied, return true.

Specified by:

evaluate in interface Condition

fileExists

public static Filesystem fileExists(File resource)

Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a normal file.

The given file path may be parameterized:

new File("/tmp/file.txt")
new File("c:\tmp\{param}.txt")
...

Parameters:

location - ParameterizedPattern specifying the location of the File.

See Also:

ConfigurationRuleParameterBuilder#where(String)}

directoryExists

public static Filesystem directoryExists(File resource)

Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a directory.

The given file path may be parameterized:

new File("/tmp/directory/")
new File("c:\tmp\{param}")
...

Parameters:

location - ParameterizedPattern specifying the location of the directory.

See Also:

ConfigurationRuleParameterBuilder#where(String)}

getExpression

public ParameterizedPatternParser getExpression()

Get the ParameterizedPattern of this Filesystem.

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Description copied from interface: Parameterized

Get all required Parameter names for this Parameterized instance.

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Description copied from interface: Parameterized

Initialize this Parameterized instance with the global ParameterStore.

Specified by:

setParameterStore in interface Parameterized