alma.acs.config.validators

Class ConfigFileRedeemerFilepath

java.lang.Object

alma.acs.config.validators.ConfigFileRedeemer

alma.acs.config.validators.ConfigFileRedeemerFilepath

public class ConfigFileRedeemerFilepath
extends ConfigFileRedeemer

Redeems files based on (part of) their path name. This class should be used to ignore files under certain directories, or specific files.

One should be careful to use path name snippets that match as accurately as possible, to avoid excluding other files whose path names unexpectedly also match. For better accuracy, you should

• Anchor top-level directories to the base dir of the search using the ^ character prepended to the path name snippet set in addRedeemedFilePathSnippet(String).
  For example, the path name snippet ^ITS will exclude all files under /alma/src/MONTHLY-2006-03-ITER-2/ITS if the base directory in ConfigFileFinder is given as /alma/src/MONTHLY-2006-03-ITER-2. However it will not exclude files under mymodule/src/alma/mypackage/ITS/blabla.
• To exclude the test directory in all modules, use the specialized filter ConfigFileRedeemerTestDir which not only checks whether /test/ is on the path name, but also looks for a parallel src directory with a Makefile and thus minimizes the risk of a false match.

Author:

hsommer

Field Summary

Fields inherited from class alma.acs.config.validators.ConfigFileRedeemer

logger

Constructor Summary

Constructors

Constructor and Description
ConfigFileRedeemerFilepath(java.util.logging.Logger logger, java.io.File baseDir)

Method Summary

Modifier and Type	Method and Description
protected boolean	_isNotAConfigFile(java.io.File file) Called by ConfigFileRedeemer.isNotAConfigFile(File) only if the file ending matches one of the endings in ConfigFileRedeemer.getFileEndings().
void	addRedeemedFilePathSnippet(java.lang.String filePathSnippet)
void	configure() This method may be overridden by a subclass.
java.lang.String[]	getFileEndings() Returns null so that it gets to redeem any kind of file.

Methods inherited from class alma.acs.config.validators.ConfigFileRedeemer

getName, isNotAConfigFile

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigFileRedeemerFilepath

public ConfigFileRedeemerFilepath(java.util.logging.Logger logger,
                                  java.io.File baseDir)

Method Detail

_isNotAConfigFile

protected boolean _isNotAConfigFile(java.io.File file)

Description copied from class: ConfigFileRedeemer

Called by ConfigFileRedeemer.isNotAConfigFile(File) only if the file ending matches one of the endings in ConfigFileRedeemer.getFileEndings().

Specified by:

_isNotAConfigFile in class ConfigFileRedeemer

getFileEndings

public java.lang.String[] getFileEndings()

Returns null so that it gets to redeem any kind of file.

Specified by:

getFileEndings in class ConfigFileRedeemer

Returns:

addRedeemedFilePathSnippet

public void addRedeemedFilePathSnippet(java.lang.String filePathSnippet)

configure

public void configure()

This method may be overridden by a subclass. TODO: read in from file instead of hardcoding the snippets