hudson.plugins.scm_sync_configuration.strategies.model

Class JobOrFolderConfigurationEntityMatcher

java.lang.Object

hudson.plugins.scm_sync_configuration.strategies.model.PatternsEntityMatcher

hudson.plugins.scm_sync_configuration.strategies.model.JobOrFolderConfigurationEntityMatcher

All Implemented Interfaces:

ConfigurationEntityMatcher

public class JobOrFolderConfigurationEntityMatcher
extends PatternsEntityMatcher

A ConfigurationEntityMatcher for job and Cloudbees Folders plugin folder configuration files. Matches config.xml located in jobs/project/config.xml (normal Jenkins), but also in nested directories below that as long as the path has the pattern (jobs/someName/)+config.xml (Cloudbees directory structure).

Constructor Summary

Constructors

Constructor and Description
JobOrFolderConfigurationEntityMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getIncludes() All patterns this matcher matches; used only for informational purposes in the UI.
boolean	matches(hudson.model.Saveable saveable, File file) Determines whether the matcher matches a given combination of saveable and file.
boolean	matches(hudson.model.Saveable saveable, String pathRelativeToRoot, boolean isDirectory) Determines whether the matcher would have matched a deleted file, of which we know only its path and possibly whether it was directory.
String[]	matchingFilesFrom(File rootDirectory, org.apache.tools.ant.types.selectors.FileSelector selector) Collects all files under the given rootDirectory that match, restricted by the given link FileSelector.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobOrFolderConfigurationEntityMatcher

public JobOrFolderConfigurationEntityMatcher()

Method Detail

matches

public boolean matches(hudson.model.Saveable saveable,
              File file)

Description copied from interface: ConfigurationEntityMatcher

Determines whether the matcher matches a given combination of saveable and file.

Specified by:

matches in interface ConfigurationEntityMatcher

Overrides:

matches in class PatternsEntityMatcher

Parameters:

saveable - the file belongs to

file - that is to be matched

Returns:

true on match, false otherwise

matches

public boolean matches(hudson.model.Saveable saveable,
              String pathRelativeToRoot,
              boolean isDirectory)

Description copied from interface: ConfigurationEntityMatcher

Determines whether the matcher would have matched a deleted file, of which we know only its path and possibly whether it was directory.

Specified by:

matches in interface ConfigurationEntityMatcher

Overrides:

matches in class PatternsEntityMatcher

Parameters:

saveable - the file belonged to

pathRelativeToRoot - of the file or directory (which Jenkins has already deleted)

isDirectory - true if it's known that the path referred to a directory, false otherwise

Returns:

true on match, false otherwise

getIncludes

public List<String> getIncludes()

Description copied from interface: ConfigurationEntityMatcher

All patterns this matcher matches; used only for informational purposes in the UI.

Specified by:

getIncludes in interface ConfigurationEntityMatcher

Overrides:

getIncludes in class PatternsEntityMatcher

Returns:

A list of explanatory messages about the pattern the matcher matches.

matchingFilesFrom

public String[] matchingFilesFrom(File rootDirectory,
                         org.apache.tools.ant.types.selectors.FileSelector selector)

Description copied from interface: ConfigurationEntityMatcher

Collects all files under the given rootDirectory that match, restricted by the given link FileSelector.

Specified by:

matchingFilesFrom in interface ConfigurationEntityMatcher

Overrides:

matchingFilesFrom in class PatternsEntityMatcher

Parameters:

rootDirectory - to traverse

selector - restricting the traversal

Returns:

an array of all path names relative to the rootDirectory of all files that match.