hudson.plugins.scm_sync_configuration.strategies.model

Interface ConfigurationEntityMatcher

All Known Implementing Classes:

ClassAndFileConfigurationEntityMatcher, JobOrFolderConfigurationEntityMatcher, PatternsEntityMatcher

public interface ConfigurationEntityMatcher

A matcher that matches specific files under $JENKINS_HOME.

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.

Method Detail

matches

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

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

Parameters:

saveable - the file belongs to

file - that is to be matched

Returns:

true on match, false otherwise

matches

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.

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

matchingFilesFrom

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.

Parameters:

rootDirectory - to traverse

selector - restricting the traversal

Returns:

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

getIncludes

List<String> getIncludes()

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

Returns:

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