org.mule.extension.file.common.api.matcher

Class FileMatcher<T extends FileMatcher<T,A>,A extends FileAttributes>

java.lang.Object

org.mule.extension.file.common.api.matcher.FileMatcher<T,A>

Type Parameters:

T - this instance concrete type. It allows to extend this class while allowing setter chains

A - The concrete implementation of FileAttributes that this builder uses to assert the file properties

public abstract class FileMatcher<T extends FileMatcher<T,A>,A extends FileAttributes>
extends Object

Builds a Predicate which verifies that a FileAttributes instance is compliant with a number of criteria. This builder is stateful and not thread-safe. A new instance should be use per each desired Predicate.

This builder can either be used programmatically or through Mule's SDK since its internal state is annotated with the Parameter annotation.

Criteria are evaluated using an AND operator, meaning that for the predicate to accept a file, ALL the criteria must be met.

None of the criteria fields are mandatory. If a particular criterion is not specified, then it's simply not applied on the evaluation.

The class is also given the "matcher" alias to make it DSL/XML friendly.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static TimeSinceFunction	FILE_TIME_SINCE
protected static TimeUntilFunction	FILE_TIME_UNTIL

Constructor Summary

Constructors

Constructor and Description
FileMatcher()

Method Summary

Modifier and Type	Method and Description
protected Predicate<A>	addConditions(Predicate<A> predicate) This method is invoked by build() before returning the built Predicate.
Predicate<A>	build() Builds a Predicate from the criterias in this builder's state.
MatchPolicy	getDirectories()
String	getFilenamePattern()
Long	getMaxSize()
Long	getMinSize()
String	getPathPattern()
MatchPolicy	getRegularFiles()
MatchPolicy	getSymLinks()
T	setCaseSensitive(boolean caseSensitive) Whether files are matched in a case-sensitive manner.
T	setDirectories(MatchPolicy directories)
T	setFilenamePattern(String filenamePattern)
T	setFileSeparator(String fileSeparator) Separator used in paths (e.g.
T	setMaxSize(Long maxSize)
T	setMinSize(Long minSize)
T	setPathPattern(String pathPattern)
T	setRegularFiles(MatchPolicy regularFiles)
T	setSymLinks(MatchPolicy symLinks)

Methods inherited from class java.lang.Object

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

Field Detail

FILE_TIME_UNTIL

protected static final TimeUntilFunction FILE_TIME_UNTIL

FILE_TIME_SINCE

protected static final TimeSinceFunction FILE_TIME_SINCE

Constructor Detail

FileMatcher

public FileMatcher()

Method Detail

build

public Predicate<A> build()

Builds a Predicate from the criterias in this builder's state.

Returns:

a Predicate

addConditions

protected Predicate<A> addConditions(Predicate<A> predicate)

This method is invoked by build() before returning the built Predicate.

It allows extending classes to modify the returned Predicate.

Parameters:

predicate - the Predicate that is about to be returned by build()

Returns:

a new instance or the same one in case no modification is required.

getFilenamePattern

public String getFilenamePattern()

getPathPattern

public String getPathPattern()

getDirectories

public MatchPolicy getDirectories()

getRegularFiles

public MatchPolicy getRegularFiles()

getSymLinks

public MatchPolicy getSymLinks()

getMinSize

public Long getMinSize()

getMaxSize

public Long getMaxSize()

setFilenamePattern

public T setFilenamePattern(String filenamePattern)

setPathPattern

public T setPathPattern(String pathPattern)

setDirectories

public T setDirectories(MatchPolicy directories)

setRegularFiles

public T setRegularFiles(MatchPolicy regularFiles)

setSymLinks

public T setSymLinks(MatchPolicy symLinks)

setMinSize

public T setMinSize(Long minSize)

setMaxSize

public T setMaxSize(Long maxSize)

setCaseSensitive

public T setCaseSensitive(boolean caseSensitive)

Whether files are matched in a case-sensitive manner.

setFileSeparator

public T setFileSeparator(String fileSeparator)

Separator used in paths (e.g. "/" on Linux and "\" on Windows.