alma::acs::config::validators::ConfigFileRedeemerFilepath Class Reference

Inheritance diagram for alma::acs::config::validators::ConfigFileRedeemerFilepath:

[legend]

Collaboration diagram for alma::acs::config::validators::ConfigFileRedeemerFilepath:

[legend]

List of all members.

Public Member Functions
	ConfigFileRedeemerFilepath (Logger logger, File baseDir)
String[]	getFileEndings ()
void	addRedeemedFilePathSnippet (String filePathSnippet)
void	configure ()
Protected Member Functions
boolean	_isNotAConfigFile (File file)
Private Attributes
List< String >	redeemedFilePathSnippets
String	baseDirPath

---

Detailed Description

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

---

Constructor & Destructor Documentation

alma::acs::config::validators::ConfigFileRedeemerFilepath::ConfigFileRedeemerFilepath	(	Logger	logger,
		File	baseDir
	)			[inline]

References baseDirPath, configure(), and redeemedFilePathSnippets.

---

Member Function Documentation

boolean alma::acs::config::validators::ConfigFileRedeemerFilepath::_isNotAConfigFile

(

File

file

)

[inline, protected, virtual]

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

Implements alma::acs::config::validators::ConfigFileRedeemer.

References baseDirPath, alma::acs::config::validators::ConfigFileRedeemer::logger, and redeemedFilePathSnippets.

void alma::acs::config::validators::ConfigFileRedeemerFilepath::addRedeemedFilePathSnippet

(

String

filePathSnippet

)

[inline]

References redeemedFilePathSnippets.

Referenced by configure().

void alma::acs::config::validators::ConfigFileRedeemerFilepath::configure

(

)

[inline]

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

References addRedeemedFilePathSnippet().

Referenced by ConfigFileRedeemerFilepath().

String [] alma::acs::config::validators::ConfigFileRedeemerFilepath::getFileEndings

(

)

[inline, virtual]

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

Implements alma::acs::config::validators::ConfigFileRedeemer.

---

Member Data Documentation

String alma::acs::config::validators::ConfigFileRedeemerFilepath::baseDirPath [private]

Referenced by _isNotAConfigFile(), and ConfigFileRedeemerFilepath().

List<String> alma::acs::config::validators::ConfigFileRedeemerFilepath::redeemedFilePathSnippets [private]

Referenced by _isNotAConfigFile(), addRedeemedFilePathSnippet(), and ConfigFileRedeemerFilepath().

---

The documentation for this class was generated from the following file:

• ConfigFileRedeemerFilepath.java