Package com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.job

Class RegexNameRestriction

java.lang.Object

com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.job.RegexNameRestriction

All Implemented Interfaces:

ExtensionPoint, Describable<JobRestriction>, Serializable

public class RegexNameRestriction
extends JobRestriction

Restricts the jobs execution by applying regular expressions to their names.

Author:

Oleg Nenashev

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegexNameRestriction.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

DEFAULT

Constructor Summary

Constructors

Constructor	Description
RegexNameRestriction(String regexExpression, boolean checkShortName)

Method Summary

Modifier and Type	Method	Description
boolean	canTake(Queue.BuildableItem item)	Check if the Queue item can be taken.
boolean	canTake(Run run)	Check if the Job can be executed according to the specified Run.
boolean	canTake(String projectName)
String	getRegexExpression()
boolean	isCheckShortName()

Methods inherited from class com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

all, allDescriptors, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

RegexNameRestriction

@DataBoundConstructor
public RegexNameRestriction(String regexExpression,
 boolean checkShortName)

Method Details

getRegexExpression

public String getRegexExpression()

isCheckShortName

public boolean isCheckShortName()

canTake

public boolean canTake(Queue.BuildableItem item)

Description copied from class: JobRestriction

Check if the Queue item can be taken. This method is being used to check if the Node can take the specified job. If the job cannot be taken, Jenkins will try to launch the job on other nodes.

Specified by:

canTake in class JobRestriction

Parameters:

item - An item to be checked

Returns:

true if the node can take the item

canTake

public boolean canTake(Run run)

Description copied from class: JobRestriction

Check if the Job can be executed according to the specified Run. If the job cannot be executed, it will be aborted by the plugin.

Specified by:

canTake in class JobRestriction

Parameters:

run - A Run to be checked

Returns:

true if the build can be executed

canTake

public boolean canTake(String projectName)