Package org.springframework.integration.file.filters

Class CompositeFileListFilter<F>

java.lang.Object

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

Type Parameters:

F - The type that will be filtered.

All Implemented Interfaces:

Closeable, AutoCloseable, DiscardAwareFileListFilter<F>, FileListFilter<F>, ResettableFileListFilter<F>, ReversibleFileListFilter<F>

Direct Known Subclasses:

ChainFileListFilter

public class CompositeFileListFilter<F>
extends Object
implements ReversibleFileListFilter<F>, ResettableFileListFilter<F>, DiscardAwareFileListFilter<F>, Closeable

Simple FileListFilter that predicates its matches against all of the configured FileListFilter.

Note: when discardCallback is provided, it is populated to all the DiscardAwareFileListFilter delegates. In this case, since this filter matches the files against all delegates, the discardCallback may be called several times for the same file.

Author:

Iwein Fuld, Josh Long, Gary Russell, Artem Bilan, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<FileListFilter<F>>	fileFilters

Constructor Summary

Constructors

Constructor	Description
CompositeFileListFilter()
CompositeFileListFilter(Collection<? extends FileListFilter<F>> fileFilters)

Method Summary

Modifier and Type	Method	Description
boolean	accept(F file)	Filter a single file; only called externally if FileListFilter.supportsSingleFileFiltering() returns true.
void	addDiscardCallback(Consumer<F> discardCallbackToSet)
CompositeFileListFilter<F>	addFilter(FileListFilter<F> filter)
CompositeFileListFilter<F>	addFilters(Collection<? extends FileListFilter<F>> filtersToAdd)	Add the new filters to this CompositeFileListFilter while maintaining the existing filters.
final CompositeFileListFilter<F>	addFilters(FileListFilter<F>... filters)
void	close()
List<F>	filterFiles(F[] files)	Filters out files and returns the files that are left in a list, or an empty list when a null is passed in.
boolean	isForRecursion()	Return true if this filter is being used for recursion.
boolean	remove(F f)	Remove the specified file from the filter, so it will pass on the next attempt.
void	rollback(F file, List<F> files)	Indicate that not all files previously passed by this filter (in FileListFilter.filterFiles(Object[]) have been processed; the file must be in the list of files; it, and all files after it, will be considered to have not been processed and will be considered next time.
boolean	supportsSingleFileFiltering()	Indicates that this filter supports filtering a single file.

Methods inherited from class java.lang.Object

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

Field Details

fileFilters

protected final Set<FileListFilter<F>> fileFilters

Constructor Details

CompositeFileListFilter

public CompositeFileListFilter()

CompositeFileListFilter

public CompositeFileListFilter(Collection<? extends FileListFilter<F>> fileFilters)

Method Details

isForRecursion

public boolean isForRecursion()

Description copied from interface: FileListFilter

Return true if this filter is being used for recursion.

Specified by:

isForRecursion in interface FileListFilter<F>

Returns:

whether or not to filter based on the full path.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

addFilter

public CompositeFileListFilter<F> addFilter(FileListFilter<F> filter)

addFilters

@SafeVarargs
public final CompositeFileListFilter<F> addFilters(FileListFilter<F>... filters)

Parameters:

filters - one or more new filters to add

Returns:

this CompositeFileFilter instance with the added filters

See Also:

• addFilters(Collection)

addFilters

public CompositeFileListFilter<F> addFilters(Collection<? extends FileListFilter<F>> filtersToAdd)

Add the new filters to this CompositeFileListFilter while maintaining the existing filters.

Parameters:

filtersToAdd - a list of filters to add

Returns:

this CompositeFileListFilter instance with the added filters

addDiscardCallback

public void addDiscardCallback(Consumer<F> discardCallbackToSet)

Specified by:

addDiscardCallback in interface DiscardAwareFileListFilter<F>

filterFiles

public List<F> filterFiles(F[] files)

Description copied from interface: FileListFilter

Filters out files and returns the files that are left in a list, or an empty list when a null is passed in.

Specified by:

filterFiles in interface FileListFilter<F>

Parameters:

files - The files.

Returns:

The filtered files.

accept

public boolean accept(F file)

Description copied from interface: FileListFilter

Filter a single file; only called externally if FileListFilter.supportsSingleFileFiltering() returns true.

Specified by:

accept in interface FileListFilter<F>

Parameters:

file - the file.

Returns:

true if the file passes the filter, false to filter.

See Also:

• FileListFilter.supportsSingleFileFiltering()

supportsSingleFileFiltering

public boolean supportsSingleFileFiltering()

Description copied from interface: FileListFilter

Indicates that this filter supports filtering a single file. Filters that return true must override FileListFilter.accept(Object). Default false.

Specified by:

supportsSingleFileFiltering in interface FileListFilter<F>

Returns:

true to allow external calls to FileListFilter.accept(Object).

See Also:

• FileListFilter.accept(Object)

rollback

public void rollback(F file,
 List<F> files)

Description copied from interface: ReversibleFileListFilter

Indicate that not all files previously passed by this filter (in FileListFilter.filterFiles(Object[]) have been processed; the file must be in the list of files; it, and all files after it, will be considered to have not been processed and will be considered next time.

Specified by:

rollback in interface ReversibleFileListFilter<F>

Parameters:

file - the file which failed.

files - the list of files that were returned by FileListFilter.filterFiles(Object[]).

remove

public boolean remove(F f)

Description copied from interface: ResettableFileListFilter

Remove the specified file from the filter, so it will pass on the next attempt.

Specified by:

remove in interface ResettableFileListFilter<F>

Parameters:

f - the element to remove.

Returns:

true if the file was removed as a result of this call.