jetbrains.buildServer.controllers.admin.projects
Class BuildRunnerBean

java.lang.Object
  extended by jetbrains.buildServer.controllers.RememberState
      extended by jetbrains.buildServer.controllers.admin.projects.BuildRunnerBean
All Implemented Interfaces:
StatefulObject

public class BuildRunnerBean
extends RememberState

Holds build runner properties when a build configuration is being edited on the web


Nested Class Summary
static class BuildRunnerBean.ExecutionPolicyValue
          ExecutionPolicyValue bean
static class BuildRunnerBean.RunTypeGrouping
           
static class BuildRunnerBean.RunTypeInfo
          Represents information about a build runner in the form suitable for JSP
 
Constructor Summary
BuildRunnerBean(SBuildRunnerDescriptor runnerDescriptor, RunTypesProvider runTypeRegistry, boolean inherited, boolean enabled)
          Constructor for existing build runner
BuildRunnerBean(java.lang.String id, java.lang.String runnerType, RunTypesProvider runTypeRegistry)
          Constructor for new build runner
 
Method Summary
 java.util.Collection<java.lang.String> getAvailableRunnerExtensionUrls()
           
 java.util.Map<BuildRunnerBean.RunTypeGrouping,java.util.Collection<BuildRunnerBean.RunTypeInfo>> getAvailableRunTypes()
           
 java.lang.String getBuildStepName()
          Returns name of the build runner step
 java.lang.String getId()
          Returns unique identifier of this build runner bean
 BasePropertiesBean getPropertiesBean()
          Returns bean containing properties of the currently selected build runner
 java.lang.String getRunnerType()
          Returns type of the currently selected runner
 RunType getRunType()
           
 RunTypeWithExtensions getRunTypeWithExtensions()
           
 BuildRunnerBean.ExecutionPolicyValue getSelectedExecutionPolicy()
           
 BuildRunnerBean.RunTypeInfo getSelectedRunType()
           
 java.lang.String getShortDescription()
           
 java.lang.String getStepExecutionPolicyKey()
           
 java.util.Collection<BuildRunnerBean.ExecutionPolicyValue> getStepExecutionPolicyValues()
           
 boolean isEnabled()
           
 boolean isInherited()
           
 boolean isNewRunner()
          Returns true if this bean represents new build runner (not yet created).
 boolean isRunnerTypeSelected()
          Returns true if type of the runner is selected
 boolean isStateModified()
          Returns true if state of this bean is modified
 void setBuildStepName(java.lang.String buildStepName)
          Sets name of the build runner step
 void setRunnerType(java.lang.String runnerType)
          Selects new runner
 
Methods inherited from class jetbrains.buildServer.controllers.RememberState
findField, forgetState, isFieldModified, rememberState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BuildRunnerBean

public BuildRunnerBean(@NotNull
                       java.lang.String id,
                       @NotNull
                       java.lang.String runnerType,
                       @NotNull
                       RunTypesProvider runTypeRegistry)
Constructor for new build runner

Parameters:
runnerType - type of the runner
runTypeRegistry - build runner registry

BuildRunnerBean

public BuildRunnerBean(@NotNull
                       SBuildRunnerDescriptor runnerDescriptor,
                       @NotNull
                       RunTypesProvider runTypeRegistry,
                       boolean inherited,
                       boolean enabled)
Constructor for existing build runner

Parameters:
runTypeRegistry - build runner registry
enabled -
Method Detail

getId

@NotNull
public java.lang.String getId()
Returns unique identifier of this build runner bean

Returns:
see above

isNewRunner

public boolean isNewRunner()
Returns true if this bean represents new build runner (not yet created).

Returns:
see above

getRunnerType

public java.lang.String getRunnerType()
Returns type of the currently selected runner

Returns:
type of the currently selected runner

isRunnerTypeSelected

public boolean isRunnerTypeSelected()
Returns true if type of the runner is selected

Returns:
see above
Since:
6.0

getBuildStepName

public java.lang.String getBuildStepName()
Returns name of the build runner step

Returns:
build runner step name

setBuildStepName

public void setBuildStepName(java.lang.String buildStepName)
Sets name of the build runner step


setRunnerType

public void setRunnerType(java.lang.String runnerType)
Selects new runner

Parameters:
runnerType - new runner type

getAvailableRunTypes

@NotNull
public java.util.Map<BuildRunnerBean.RunTypeGrouping,java.util.Collection<BuildRunnerBean.RunTypeInfo>> getAvailableRunTypes()

getSelectedRunType

@NotNull
public BuildRunnerBean.RunTypeInfo getSelectedRunType()

getRunType

@NotNull
public RunType getRunType()

getRunTypeWithExtensions

@Nullable
public RunTypeWithExtensions getRunTypeWithExtensions()

getShortDescription

@NotNull
public java.lang.String getShortDescription()

isInherited

public boolean isInherited()
Returns:
true if this runner is inherited from template

isEnabled

public boolean isEnabled()
Returns:
true if this runner is enabled
Since:
7.0

getStepExecutionPolicyKey

@NotNull
public java.lang.String getStepExecutionPolicyKey()
Returns:
runner parameter name for build policy
Since:
7.1

getStepExecutionPolicyValues

@NotNull
public java.util.Collection<BuildRunnerBean.ExecutionPolicyValue> getStepExecutionPolicyValues()
Returns:
all possible values for step execution policy
Since:
7.1

getSelectedExecutionPolicy

@NotNull
public BuildRunnerBean.ExecutionPolicyValue getSelectedExecutionPolicy()

getPropertiesBean

public BasePropertiesBean getPropertiesBean()
Returns bean containing properties of the currently selected build runner

Returns:
bean containing properties of the currently selected build runner

getAvailableRunnerExtensionUrls

@NotNull
public java.util.Collection<java.lang.String> getAvailableRunnerExtensionUrls()

isStateModified

public boolean isStateModified()
Returns true if state of this bean is modified

Specified by:
isStateModified in interface StatefulObject
Overrides:
isStateModified in class RememberState
Returns:
true if state of this bean is modified