hudson.plugins.git.extensions.impl

Class PathRestriction

java.lang.Object

hudson.model.AbstractDescribableImpl<GitSCMExtension>

hudson.plugins.git.extensions.GitSCMExtension

hudson.plugins.git.extensions.impl.PathRestriction

All Implemented Interfaces:

Describable<GitSCMExtension>

public class PathRestriction
extends GitSCMExtension

GitSCMExtension that ignores commits that only affects specific paths.

Author:

Juerg Haefliger, Andrew Bayer, Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathRestriction.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
PathRestriction(String includedRegions, String excludedRegions)

Method Summary

Modifier and Type	Method and Description
String	getExcludedRegions()
String[]	getExcludedRegionsNormalized()
String	getIncludedRegions()
String[]	getIncludedRegionsNormalized()
Boolean	isRevExcluded(GitSCM scm, org.jenkinsci.plugins.gitclient.GitClient git, GitChangeSet commit, TaskListener listener, BuildData buildData) Given a commit found during polling, check whether it should be disregarded.
boolean	requiresWorkspaceForPolling()

Methods inherited from class hudson.plugins.git.extensions.GitSCMExtension

beforeCheckout, beforeCheckout, decorate, decorateCheckoutCommand, decorateCheckoutCommand, decorateCloneCommand, decorateCloneCommand, decorateFetchCommand, decorateFetchCommand, decorateMergeCommand, decorateMergeCommand, decorateRevisionToBuild, decorateRevisionToBuild, determineSupportForJGit, enableMultipleRevisionDetection, getDescriptor, getRequiredClient, getWorkingDirectory, getWorkingDirectory, onCheckoutCompleted, onCheckoutCompleted, onClean, populateEnvironmentVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

PathRestriction

@DataBoundConstructor
public PathRestriction(String includedRegions,
                                             String excludedRegions)

Method Detail

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class GitSCMExtension

Returns:

true when this extension has a requirement to get a workspace during polling, typically as it has to check for incoming changes, not just remote HEAD.

getIncludedRegions

public String getIncludedRegions()

getExcludedRegions

public String getExcludedRegions()

getExcludedRegionsNormalized

public String[] getExcludedRegionsNormalized()

getIncludedRegionsNormalized

public String[] getIncludedRegionsNormalized()

isRevExcluded

@CheckForNull
public Boolean isRevExcluded(GitSCM scm,
                                           org.jenkinsci.plugins.gitclient.GitClient git,
                                           GitChangeSet commit,
                                           TaskListener listener,
                                           BuildData buildData)

Description copied from class: GitSCMExtension

Given a commit found during polling, check whether it should be disregarded.

Overrides:

isRevExcluded in class GitSCMExtension

Parameters:

scm - GitSCM object

git - GitClient object

commit - The commit whose exclusion is being tested.

listener - build log

buildData - build data to be used

Returns:

true to disregard this commit and not trigger a build, regardless of what later GitSCMExtensions say. false to trigger a build from this commit, regardless of what later GitSCMExtensions say. null to allow other GitSCMExtensions to decide.