org.jenkinsci.plugins.blockbuildfinalproject

Class BlockBuildJobProperty

java.lang.Object

hudson.model.JobProperty<hudson.model.Job<?,?>>

org.jenkinsci.plugins.blockbuildfinalproject.BlockBuildJobProperty

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.JobProperty<?>>, hudson.model.ReconfigurableDescribable<hudson.model.JobProperty<?>>, hudson.tasks.BuildStep

public class BlockBuildJobProperty
extends hudson.model.JobProperty<hudson.model.Job<?,?>>

BlockBuildJobProperty is an immutable class that holds the project properties for this plugin.

Author:

Chad Rosenquist

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockBuildJobProperty.DescriptorImpl Provides autocompletion and validation for the project textbox fields.

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
BlockBuildJobProperty() Default Constructor
BlockBuildJobProperty(boolean useBlockBuildUpstreamProject, List<String> finalUpstreamProjectsList, boolean useBlockBuildDownstreamProject, List<String> finalDownstreamProjectsList) Constructor Similar to the DataBoundConstructor, but takes a List instead of a string for the final projects.
BlockBuildJobProperty(boolean useBlockBuildUpstreamProject, String finalUpstreamProjects, boolean useBlockBuildDownstreamProject, String finalDownstreamProjects) DataBoundConstruct Created by Jenkins to store the properties for this plugin.

Method Summary

Modifier and Type	Method and Description
static BlockBuildJobProperty	getBlockBuildJobPropertyFromProject(hudson.model.AbstractProject<?,?> project) Returns the BlockBuildJobProperty for a given project.
String	getFinalDownstreamProjects()
com.google.common.collect.ImmutableList<String>	getFinalDownstreamProjectsAsList()
String	getFinalUpstreamProjects()
com.google.common.collect.ImmutableList<String>	getFinalUpstreamProjectsAsList()
boolean	isUseBlockBuildDownstreamProject()
boolean	isUseBlockBuildUpstreamProject()
BlockBuildJobProperty	onDeleted(String deletedName) When a project is deleted from Jenkins, call this function to delete that project from BlockBuildJobProperty.
BlockBuildJobProperty	onRenamed(String oldName, String newName) When a project is renamed in Jenkins, call this function to rename that project in BlockBuildJobProperty.
static void	updateBlockBuildJobPropertyInProject(hudson.model.AbstractProject<?,?> project, BlockBuildJobProperty newProperty) Updates the BlockBuildJobProperty for a given project.

Methods inherited from class hudson.model.JobProperty

getDescriptor, getJobAction, getJobActions, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockBuildJobProperty

@DataBoundConstructor
public BlockBuildJobProperty(boolean useBlockBuildUpstreamProject,
                                                    String finalUpstreamProjects,
                                                    boolean useBlockBuildDownstreamProject,
                                                    String finalDownstreamProjects)

DataBoundConstruct Created by Jenkins to store the properties for this plugin.

Parameters:

useBlockBuildUpstreamProject - true if blocking on upstream projects is enabled

finalUpstreamProjects - comma separated list of final projects

useBlockBuildDownstreamProject - true if blocking on downstream projects is enabled

finalDownstreamProjects - comma separated list of final projects

BlockBuildJobProperty

public BlockBuildJobProperty(boolean useBlockBuildUpstreamProject,
                             List<String> finalUpstreamProjectsList,
                             boolean useBlockBuildDownstreamProject,
                             List<String> finalDownstreamProjectsList)

Constructor Similar to the DataBoundConstructor, but takes a List instead of a string for the final projects.

Parameters:

useBlockBuildUpstreamProject - true if blocking on upstream projects is enabled

finalUpstreamProjectsList - List of final projects

useBlockBuildDownstreamProject - true if blocking on downstream projects is enabled

finalDownstreamProjectsList - List of final projects

BlockBuildJobProperty

public BlockBuildJobProperty()

Default Constructor

Method Detail

isUseBlockBuildUpstreamProject

public boolean isUseBlockBuildUpstreamProject()

Returns:

true if this plugin should block upstream projects

isUseBlockBuildDownstreamProject

public boolean isUseBlockBuildDownstreamProject()

Returns:

false if this plugin should block downstream projects

getFinalUpstreamProjects

public String getFinalUpstreamProjects()

Returns:

comma delimited list of final upstream projects

getFinalDownstreamProjects

public String getFinalDownstreamProjects()

Returns:

comma delimited list of final downstream projects

getFinalUpstreamProjectsAsList

public com.google.common.collect.ImmutableList<String> getFinalUpstreamProjectsAsList()

Returns:

ImmutableList of final upstream projects

getFinalDownstreamProjectsAsList

public com.google.common.collect.ImmutableList<String> getFinalDownstreamProjectsAsList()

Returns:

ImmutableList of final downstream projects

onDeleted

public BlockBuildJobProperty onDeleted(String deletedName)

When a project is deleted from Jenkins, call this function to delete that project from BlockBuildJobProperty. Because BlockBuildJobProperty is immutable, a new instance is created.

Parameters:

deletedName - name of the project being deleted

Returns:

new instance of BlockBuildJobProperty that does not contain the delete project

onRenamed

public BlockBuildJobProperty onRenamed(String oldName,
                                       String newName)

When a project is renamed in Jenkins, call this function to rename that project in BlockBuildJobProperty. Because BlockBuildJobProperty is immutable, a new instance is created.

Parameters:

oldName - old name of the project being renamed

newName - new name

Returns:

new instance of BlockBuildJobProperty with the renamed project

getBlockBuildJobPropertyFromProject

public static BlockBuildJobProperty getBlockBuildJobPropertyFromProject(hudson.model.AbstractProject<?,?> project)

Returns the BlockBuildJobProperty for a given project.

Parameters:

project - the project

Returns:

the BlockBuildJobProperty

updateBlockBuildJobPropertyInProject

public static void updateBlockBuildJobPropertyInProject(hudson.model.AbstractProject<?,?> project,
                                                        BlockBuildJobProperty newProperty)

Updates the BlockBuildJobProperty for a given project.

Parameters:

project - the project

newProperty - the new BlockBuildJobProperty If an error occurs, the stack trace is shown and an error message is logged. Execution tries to continue.