Public Member Functions | Protected Member Functions

alma.acs.config.validators.ConfigFileRedeemerFilepath Class Reference

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

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)

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

Author:
hsommer

Constructor & Destructor Documentation

alma.acs.config.validators.ConfigFileRedeemerFilepath.ConfigFileRedeemerFilepath ( Logger  logger,
File  baseDir 
)

Member Function Documentation

boolean alma.acs.config.validators.ConfigFileRedeemerFilepath._isNotAConfigFile ( File  file  )  [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 alma.acs.config.validators.ConfigFileRedeemer.logger.

void alma.acs.config.validators.ConfigFileRedeemerFilepath.addRedeemedFilePathSnippet ( String  filePathSnippet  ) 
void alma.acs.config.validators.ConfigFileRedeemerFilepath.configure (  ) 

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

References alma.acs.config.validators.ConfigFileRedeemerFilepath.addRedeemedFilePathSnippet().

Referenced by alma.acs.config.validators.ConfigFileRedeemerFilepath.ConfigFileRedeemerFilepath().

String [] alma.acs.config.validators.ConfigFileRedeemerFilepath.getFileEndings (  )  [virtual]

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

Implements alma.acs.config.validators.ConfigFileRedeemer.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties