Package org.springframework.integration.file.filters

Class AbstractRegexPatternFileListFilter<F>

java.lang.Object

org.springframework.integration.file.filters.AbstractFileListFilter<F>

org.springframework.integration.file.filters.AbstractDirectoryAwareFileListFilter<F>

org.springframework.integration.file.filters.AbstractRegexPatternFileListFilter<F>

Type Parameters:

F - the type of file entry

All Implemented Interfaces:

FileListFilter<F>

Direct Known Subclasses:

FtpRegexPatternFileListFilter, RegexPatternFileListFilter, SftpRegexPatternFileListFilter, SmbRegexPatternFileListFilter

public abstract class AbstractRegexPatternFileListFilter<F>
extends AbstractDirectoryAwareFileListFilter<F>

Filters a listing of files by qualifying their 'name' against a regular expression (an instance of Pattern).

Since:

2.0

Author:

Iwein Fuld, Josh Long, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
AbstractRegexPatternFileListFilter(String pattern)
AbstractRegexPatternFileListFilter(Pattern pattern)

Method Summary

Modifier and Type	Method	Description
boolean	accept(F file)	Subclasses must implement this method.
protected abstract String	getFilename(F file)	Subclasses must implement this method to extract the file's name.
void	setPattern(String pattern)
void	setPattern(Pattern pattern)

Methods inherited from class org.springframework.integration.file.filters.AbstractDirectoryAwareFileListFilter

alwaysAccept, isDirectory, isForRecursion, setAlwaysAcceptDirectories, setForRecursion

Methods inherited from class org.springframework.integration.file.filters.AbstractFileListFilter

filterFiles, supportsSingleFileFiltering

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRegexPatternFileListFilter

public AbstractRegexPatternFileListFilter(String pattern)

AbstractRegexPatternFileListFilter

public AbstractRegexPatternFileListFilter(Pattern pattern)

Method Details

setPattern

public void setPattern(String pattern)

setPattern

public void setPattern(Pattern pattern)

accept

public boolean accept(F file)

Description copied from class: AbstractFileListFilter

Subclasses must implement this method.

Specified by:

accept in interface FileListFilter<F>

Specified by:

accept in class AbstractFileListFilter<F>

Parameters:

file - The file.

Returns:

true if the file passes the filter.

See Also:

• FileListFilter.supportsSingleFileFiltering()

getFilename

protected abstract String getFilename(F file)

Subclasses must implement this method to extract the file's name.

Parameters:

file - The file.

Returns:

The file name.