flux.file
Interface IncludesFileCriteria

All Superinterfaces:

FileCriteria

public interface IncludesFileCriteria
extends FileCriteria

A specification of files that are involved in a file operation.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

void	addRegexFilter(java.lang.String filter) After processing includes, then excludes, filters are applied last to remove remaining files that match the specified regular expression.
void	exclude(java.lang.String filePattern) Excludes files matching the file pattern from the file patter.
java.util.Set<java.lang.String>	getExcludes() Returns the file patterns that are excluded.
java.util.Set<FilePattern>	getIncludePatterns() Returns the file patterns that are included, returned as FilePattern objects, which allow a required minimum number of matching files to be found when using wildcard file patterns.
java.util.Set<java.lang.String>	getIncludes() Returns the file patterns that are included, returned as String objects.
java.util.Set<java.lang.String>	getRegexFilters() Returns the regular expressions that filters out files.
void	include(java.lang.String filePattern) Includes files matching the specified file pattern.
void	include(java.lang.String filePattern, int minimumCount) Includes files matching the specified file pattern and minimum count, which allow a required minimum number of matching files to be found when using wildcard file patterns.

Methods inherited from interface flux.file.FileCriteria

getHost, setHost

Method Detail

addRegexFilter

void addRegexFilter(java.lang.String filter)

After processing includes, then excludes, filters are applied last to remove remaining files that match the specified regular expression.

By default, the regular expression library from JDK 1.4 is used. But if a different JDK is being used, the ORO regular expression library is used. This default behavior can be changed by referring to the File Criteria.Regex Filter section of the Flux documentation.

Parameters:

filter - The regular expression used to filter out files.

Throws:

java.lang.IllegalArgumentException - If the argument is null or empty.

exclude

void exclude(java.lang.String filePattern)

Excludes files matching the file pattern from the file patter.

Parameters:

filePattern - The file pattern to which files are matched.

Throws:

java.lang.IllegalArgumentException - If the argument is null or empty.

getExcludes

java.util.Set<java.lang.String> getExcludes()

Returns the file patterns that are excluded.

Returns:

The file patterns that are excluded.

getIncludePatterns

java.util.Set<FilePattern> getIncludePatterns()

Returns the file patterns that are included, returned as FilePattern objects, which allow a required minimum number of matching files to be found when using wildcard file patterns. The file criteria is satisfied when the number of files matching the file pattern reaches the specified minimum.

Returns:

Returns the file patterns that are included.

getIncludes

java.util.Set<java.lang.String> getIncludes()

Returns the file patterns that are included, returned as String objects. Any information about the minimum number of matching files is not returned.

Returns:

The file patterns that are included.

getRegexFilters

java.util.Set<java.lang.String> getRegexFilters()

Returns the regular expressions that filters out files.

Returns:

The regular expressions that filter out files.

include

void include(java.lang.String filePattern)

Includes files matching the specified file pattern.

Parameters:

filePattern - The file pattern to which files are matched.

Throws:

java.lang.IllegalArgumentException - If filePattern is null or empty.

include

void include(java.lang.String filePattern,
             int minimumCount)

Includes files matching the specified file pattern and minimum count, which allow a required minimum number of matching files to be found when using wildcard file patterns. The file criteria is satisfied when the number of files matching the file pattern reaches the specified minimum.

For most file triggers, the trigger will fire if the total number of matching files is greater than or equal to the minimum count. The File Not Exist Trigger, however, will fire if the total number of matching files is less than the minimum count.

For file actions, if the action cannot locate enough source files to satisfy the minimum count for this include, the action will throw a flux.file.FileActionException and the flow chart will enter the standard error handling mechanism.

Parameters:

filePattern - The file pattern to which files are matched.

minimumCount - The number of files that must be matched.

Throws:

java.lang.IllegalArgumentException - If the argument is null or empty.