Package jenkins.model

Class ProjectNamingStrategy.PatternProjectNamingStrategy

java.lang.Object

jenkins.model.ProjectNamingStrategy

jenkins.model.ProjectNamingStrategy.PatternProjectNamingStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<ProjectNamingStrategy>, Serializable

Enclosing class:

ProjectNamingStrategy

public static final class ProjectNamingStrategy.PatternProjectNamingStrategy
extends ProjectNamingStrategy
implements Serializable

Naming strategy which allows the admin to define a pattern a job's name has to follow.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProjectNamingStrategy.PatternProjectNamingStrategy.DescriptorImpl

Nested classes/interfaces inherited from class jenkins.model.ProjectNamingStrategy

ProjectNamingStrategy.DefaultProjectNamingStrategy, ProjectNamingStrategy.PatternProjectNamingStrategy, ProjectNamingStrategy.ProjectNamingStrategyDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class jenkins.model.ProjectNamingStrategy

DEFAULT_NAMING_STRATEGY

Constructor Summary

Constructors

Constructor	Description
PatternProjectNamingStrategy(String namePattern, boolean forceExistingJobs)	Deprecated.
PatternProjectNamingStrategy(String namePattern, String description, boolean forceExistingJobs)

Method Summary

Modifier and Type	Method	Description
void	checkName(String name)	Called when creating a new job.
String	getDescription()
String	getNamePattern()
boolean	isForceExistingJobs()	This flag can be used to force existing jobs to be migrated to a new naming strategy - if this method returns true, the naming will be enforced at every config change.

Methods inherited from class jenkins.model.ProjectNamingStrategy

all, checkName, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

PatternProjectNamingStrategy

@Deprecated
public PatternProjectNamingStrategy(String namePattern,
 boolean forceExistingJobs)

Deprecated.

PatternProjectNamingStrategy

@DataBoundConstructor
public PatternProjectNamingStrategy(String namePattern,
 String description,
 boolean forceExistingJobs)

Since:

1.533

Method Details

checkName

public void checkName(String name)

Description copied from class: ProjectNamingStrategy

Called when creating a new job.

Overrides:

checkName in class ProjectNamingStrategy

Parameters:

name - the name given from the UI

getNamePattern

public String getNamePattern()

getDescription

public String getDescription()

Since:

1.533

isForceExistingJobs

public boolean isForceExistingJobs()

Description copied from class: ProjectNamingStrategy

This flag can be used to force existing jobs to be migrated to a new naming strategy - if this method returns true, the naming will be enforced at every config change. If false is returned, only new jobs have to follow the strategy.

Overrides:

isForceExistingJobs in class ProjectNamingStrategy

Returns:

true if existing jobs should be enforced to confirm to the naming standard.