hudson.plugins.scm_sync_configuration.strategies

Class AbstractScmSyncStrategy

java.lang.Object

hudson.plugins.scm_sync_configuration.strategies.AbstractScmSyncStrategy

All Implemented Interfaces:

ScmSyncStrategy

Direct Known Subclasses:

BasicPluginsConfigScmSyncStrategy, JenkinsConfigScmSyncStrategy, JobConfigScmSyncStrategy, ManualIncludesScmSyncStrategy, UserConfigScmSyncStrategy

public abstract class AbstractScmSyncStrategy
extends Object
implements ScmSyncStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractScmSyncStrategy.DefaultCommitMessageFactory

Nested classes/interfaces inherited from interface hudson.plugins.scm_sync_configuration.strategies.ScmSyncStrategy

ScmSyncStrategy.CommitMessageFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScmSyncStrategy(ConfigurationEntityMatcher _configEntityMatcher, List<PageMatcher> _pageMatchers)

Method Summary

Methods

Modifier and Type	Method and Description
List<File>	collect() Collects all files, from Jenkins' root directory, that match this strategy.
List<File>	collect(File directory) Collects all files in the given directory, which must be under Jenkins' root directory, that match this strategy.
protected ConfigurationEntityMatcher	createConfigEntityMatcher()
ScmSyncStrategy.CommitMessageFactory	getCommitMessageFactory()
PageMatcher	getPageMatcherMatching(String url)
List<String>	getSyncIncludes()
boolean	isCurrentUrlApplicable(String url) Is the given url eligible for the current strategy ?
boolean	isSaveableApplicable(hudson.model.Saveable saveable, File file) Is the given Saveable eligible for the current strategy ?

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.plugins.scm_sync_configuration.strategies.ScmSyncStrategy

mightHaveBeenApplicableToDeletedSaveable

Constructor Detail

AbstractScmSyncStrategy

protected AbstractScmSyncStrategy(ConfigurationEntityMatcher _configEntityMatcher,
                       List<PageMatcher> _pageMatchers)

Method Detail

createConfigEntityMatcher

protected ConfigurationEntityMatcher createConfigEntityMatcher()

isSaveableApplicable

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

Description copied from interface: ScmSyncStrategy

Is the given Saveable eligible for the current strategy ?

Specified by:

isSaveableApplicable in interface ScmSyncStrategy

Parameters:

saveable - A saveable which is saved

file - Corresponding file to the given Saveable object

Returns:

true if current Saveable instance matches with current ScmSyncStrategy target, false otherwise

getPageMatcherMatching

public PageMatcher getPageMatcherMatching(String url)

collect

public List<File> collect()

Description copied from interface: ScmSyncStrategy

Collects all files, from Jenkins' root directory, that match this strategy.

Specified by:

collect in interface ScmSyncStrategy

Returns:

the list of files matched.

collect

public List<File> collect(File directory)

Description copied from interface: ScmSyncStrategy

Collects all files in the given directory, which must be under Jenkins' root directory, that match this strategy.

Specified by:

collect in interface ScmSyncStrategy

Parameters:

directory - to search in

Returns:

the list of files

isCurrentUrlApplicable

public boolean isCurrentUrlApplicable(String url)

Description copied from interface: ScmSyncStrategy

Is the given url eligible for the current strategy ?

Specified by:

isCurrentUrlApplicable in interface ScmSyncStrategy

Parameters:

url - Current url, where hudson root url has been truncated

Returns:

true if current url matches with current ScmSyncStrategy target, false otherwise

getSyncIncludes

public List<String> getSyncIncludes()

Specified by:

getSyncIncludes in interface ScmSyncStrategy

Returns:

List of sync'ed file includes brought by current strategy. Used only for informational purposes in the UI.

getCommitMessageFactory

public ScmSyncStrategy.CommitMessageFactory getCommitMessageFactory()

Specified by:

getCommitMessageFactory in interface ScmSyncStrategy

Returns:

A Factory intended to generate commit message depending on contexts