jetbrains.buildServer.serverSide
Interface BuildTypeSettings

All Superinterfaces:
BuildTypeOptions, CompatibleAgents, DependencySettings, InheritableUserParametersHolder, OptionSupport, ReadOnlyUserParameters, UserParametersHolder, VcsLabelingSettings
All Known Subinterfaces:
BuildTypeTemplate, RemoteBuildType, SBuildType

public interface BuildTypeSettings
extends BuildTypeOptions, InheritableUserParametersHolder, DependencySettings, VcsLabelingSettings, CompatibleAgents

Contains build configuration settings

Since:
5.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
VcsLabelingSettings.LabelingType
 
Field Summary
 
Fields inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions
BT_ALLOW_EXTERNAL_STATUS, BT_BUILD_NUMBER_PATTERN, BT_CLEAN_BUILD, BT_EXECUTION_TIMEOUT, BT_FAIL_IF_TESTS_FAIL, BT_FAIL_ON_ANY_ERROR_MESSAGE, BT_FAIL_ON_EXIT_CODE, BT_FAIL_ON_OOME_OR_CRASH, BT_HANGING_BUILDS_DETECTION_ENABLED, BT_MAX_RUNNING_BUILDS, BT_SHOW_DEPS_CHANGES, DEFAULT_BUILD_NUMBER_PATTERN, DEFAULT_VCS_LABELING_BRANCH_FILTER, VCS_LABELING_BRANCH_FILTER
 
Fields inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
DEFAULT_LABEL_PATTERN
 
Method Summary
 void addBuildFeature(SBuildFeatureDescriptor feature)
          Adds build feature descriptor to this settings object.
 SBuildFeatureDescriptor addBuildFeature(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> params)
          Adds build feature with specified type and parameters to this settings object.
 void addBuildParameter(Parameter parameter)
          Adds build parameter to the configuration.
 SBuildRunnerDescriptor addBuildRunner(BuildRunnerDescriptor runner)
          Adds runner descriptor.
 SBuildRunnerDescriptor addBuildRunner(java.lang.String name, java.lang.String runnerType, java.util.Map<java.lang.String,java.lang.String> parameters)
          Creates new build runner and adds it to these settings.
 boolean addBuildTrigger(BuildTriggerDescriptor triggerDescriptor)
          Adds new trigger to build configuration settings.
 BuildTriggerDescriptor addBuildTrigger(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> params)
          Adds new trigger of specified type and with specified parameters to build configuration settings.
 void addConfigParameter(Parameter param)
          Adds configuration parameter.
 void addRequirement(Requirement requirement)
          Adds new build requirement to the configuration.
 boolean addVcsRoot(SVcsRoot root)
          Adds VCS root to the build configuration with default checkout rules.
 void applyRunnersOrder(java.lang.String[] ids)
          Accepts array of runner identifiers and reorders them according to this array.
 boolean containsVcsRoot(long vcsRootId)
          Returns true if VCS root with specified is attached to the build configuration
 SBuildRunnerDescriptor findBuildRunnerById(java.lang.String runnerId)
          Finds build runner by its' id
 SBuildRunnerDescriptor findBuildRunnerByType(java.lang.String runnerType)
          Finds build runner by its' type.
 java.lang.String findRunnerParameter(java.lang.String paramName)
          Searches runner parameter in all build runners and returns value of the first found parameter with given name.
 BuildTriggerDescriptor findTriggerById(java.lang.String triggerId)
          Finds build trigger descriptor by its' id
 java.util.List<SArtifactDependency> getArtifactDependencies()
          Returns artifacts this build configuration depending on.
 java.lang.String getArtifactPaths()
          Returns build artifact paths.
 java.util.Collection<SBuildFeatureDescriptor> getBuildFeatures()
          Returns build features added to this settings object.
 java.lang.String getBuildNumberPattern()
          Returns current build number pattern
 java.lang.String getBuildParameter(java.lang.String key)
          Returns build parameter by parameter key
 java.util.Map<java.lang.String,java.lang.String> getBuildParameters()
          Return map of build parameters specified by user.
 java.util.Collection<Parameter> getBuildParametersCollection()
          Returns build parameters collection.
 java.util.List<SBuildRunnerDescriptor> getBuildRunners()
          Returns collection of build runners attached to these settings
 java.util.Collection<BuildTriggerDescriptor> getBuildTriggersCollection()
          Returns collection of build trigger settings
 java.lang.String getCheckoutDirectory()
          Returns build checkout directory - if specified explicitly.
 CheckoutRules getCheckoutRules(VcsRoot root)
          Returns checkout rules configured for the specified VCS root.
 BuildTypeDescriptor.CheckoutType getCheckoutType()
          Returns method used by agent to retrieve project sources.
 java.util.Map<java.lang.String,java.lang.String> getConfigParameters()
          Returns map of configuration parameters
 java.util.Collection<Parameter> getConfigParametersCollection()
          Returns collection of configuration parameters.
 java.util.List<Requirement> getImplicitRequirements()
          Get list of non-satisfied implicit requirements for build agents.
 SProject getProject()
          Returns the project this build type entity belongs to.
 java.util.List<Requirement> getRequirements()
          Get list of explicit requirements for build agents which can run this build configuration.
 java.util.Collection<java.lang.String> getRunnerTypes()
          Returns types of the runners attached to these settings
 java.util.List<Requirement> getRunTypeRequirements()
          Returns list of additional agent requirements imposed by configured runners.
 BuildTypeTemplate getTemplate()
          Returns template these settings are based on.
 java.lang.String getTemplateId()
          Returns id of the template if settings are template based and null otherwise
 java.util.List<java.lang.String> getUndefinedParameters()
          Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided.
 java.util.List<VcsRootEntry> getVcsRootEntries()
          Returns all entries of vcs roots.
 java.util.List<SVcsRoot> getVcsRoots()
          Returns all roots currently attached to this configuration
 boolean isEnabled(java.lang.String parametersDescriptorId)
          Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.
 boolean isTemplateBased()
          Returns true if these settings are based on a template
 void persist()
          Persists these settings.
 void removeAllBuildRunners()
          Removes all build runners from these settings
 SBuildFeatureDescriptor removeBuildFeature(java.lang.String featureId)
          Removes build feature with specified id from this settings object.
 void removeBuildParameter(java.lang.String paramName)
          Removes existing build parameter by its name.
 SBuildRunnerDescriptor removeBuildRunner(java.lang.String runnerId)
          Removes runner descriptor with specified id.
 boolean removeBuildTrigger(BuildTriggerDescriptor triggerDescriptor)
          Removes specified build trigger from the settings
 void removeConfigParameter(java.lang.String paramName)
          Removes configuration parameters with specified name
 void removeRequirement(java.lang.String parameterName)
          Removes requirement with the specified property name from the configuration.
 boolean removeVcsRoot(SVcsRoot root)
          Removes existing VCS root from the build configuration.
 boolean replaceInValues(java.lang.String regexp, java.lang.String replacement)
          Replaces values according to specified regexp and replacement string in all text parameters of the build configuration
 void setArtifactDependencies(java.util.List<SArtifactDependency> artifacts)
          Sets artifacts this build configuration depending on.
 void setArtifactPaths(java.lang.String artifactPaths)
          Sets build artifact paths.
 void setBuildNumberPattern(java.lang.String pattern)
          Sets build number pattern.
 void setCheckoutDirectory(java.lang.String dir)
          Sets build checkout directory.
 boolean setCheckoutRules(VcsRoot root, CheckoutRules checkoutRules)
          Sets checkout rules for specified VCS root.
 void setCheckoutType(BuildTypeDescriptor.CheckoutType type)
          Sets preferred checkout type for the configuration sources.
 void setEnabled(java.lang.String parametersDescriptorId, boolean enabled)
          Enables or disables descriptor with specified id in build configuration settings.
 boolean updateBuildFeature(java.lang.String featureId, java.lang.String newType, java.util.Map<java.lang.String,java.lang.String> newParams)
          Updates build feature descriptor with specified id, changes type and parameters.
 boolean updateBuildRunner(java.lang.String runnerId, java.lang.String newName, java.lang.String newType, java.util.Map<java.lang.String,java.lang.String> newParams)
          Updates parameters in the existing build runner descriptor.
 boolean updateBuildTrigger(java.lang.String triggerId, java.lang.String newType, java.util.Map<java.lang.String,java.lang.String> newParams)
          Updates build trigger descriptor with specified id, changes type and parameters.
 
Methods inherited from interface jetbrains.buildServer.util.OptionSupport
getChangedOptions, getOption, setOption
 
Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolder
getOwnParameters, getOwnParametersCollection, getParameters, getParametersCollection
 
Methods inherited from interface jetbrains.buildServer.serverSide.UserParametersHolder
addParameter, removeParameter
 
Methods inherited from interface jetbrains.buildServer.serverSide.dependency.DependencySettings
addDependency, getDependencies, removeDependency
 
Methods inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
getLabelingRoots, getLabelingType, getLabelPattern, setLabelingRoots, setLabelingType, setLabelPattern
 
Methods inherited from interface jetbrains.buildServer.serverSide.CompatibleAgents
getAgentCompatibility, getCompatibilityMap, getCompatibleAgents
 

Method Detail

getProject

@NotNull
SProject getProject()
Returns the project this build type entity belongs to.

Returns:
the project this build type entity belongs to.

getRunnerTypes

@NotNull
java.util.Collection<java.lang.String> getRunnerTypes()
Returns types of the runners attached to these settings

Returns:
see above
Since:
6.0

getRunTypeRequirements

@NotNull
java.util.List<Requirement> getRunTypeRequirements()
Returns list of additional agent requirements imposed by configured runners.

Returns:
see above

addBuildRunner

@NotNull
SBuildRunnerDescriptor addBuildRunner(@NotNull
                                              BuildRunnerDescriptor runner)
Adds runner descriptor. Use BuildRunnerDescriptorFactory to create instance of runner descriptor.
Before 8.0 this method required SBuildRunnerDescriptor as parameter

Parameters:
runner - descriptor
Returns:
instance of actually added runner
Since:
6.0

addBuildRunner

@NotNull
SBuildRunnerDescriptor addBuildRunner(@NotNull
                                              java.lang.String name,
                                              @NotNull
                                              java.lang.String runnerType,
                                              @NotNull
                                              java.util.Map<java.lang.String,java.lang.String> parameters)
Creates new build runner and adds it to these settings.

Parameters:
name - runner name
runnerType - type of the runner
parameters - runner parameters
Returns:
newly created runner
Since:
6.5

removeBuildRunner

@Nullable
SBuildRunnerDescriptor removeBuildRunner(@NotNull
                                                  java.lang.String runnerId)
Removes runner descriptor with specified id.

Parameters:
runner - descriptor
Returns:
removed runner descriptor
Since:
6.0

updateBuildRunner

boolean updateBuildRunner(@NotNull
                          java.lang.String runnerId,
                          @NotNull
                          java.lang.String newName,
                          @NotNull
                          java.lang.String newType,
                          @NotNull
                          java.util.Map<java.lang.String,java.lang.String> newParams)
Updates parameters in the existing build runner descriptor. Does nothing if there runner with specified id was not found.

Parameters:
runnerId - id of runner descriptor
newName - new runner name
newType - new type of the runner
newParams - new runner parameters
Returns:
true if parameters updated and false otherwise
Since:
6.5

getBuildRunners

@NotNull
java.util.List<SBuildRunnerDescriptor> getBuildRunners()
Returns collection of build runners attached to these settings

Returns:
see above
Since:
6.0

removeAllBuildRunners

void removeAllBuildRunners()
Removes all build runners from these settings

Since:
6.0

applyRunnersOrder

void applyRunnersOrder(@NotNull
                       java.lang.String[] ids)
Accepts array of runner identifiers and reorders them according to this array.

Parameters:
ids - runner identifiers
Since:
6.0

findBuildRunnerByType

@Nullable
SBuildRunnerDescriptor findBuildRunnerByType(@NotNull
                                                      java.lang.String runnerType)
Finds build runner by its' type. If there is more than one build runner, returns the first one.

Parameters:
runnerType - type of the runner
Returns:
build runner or null if runner was not found
Since:
6.0

findBuildRunnerById

@Nullable
SBuildRunnerDescriptor findBuildRunnerById(@NotNull
                                                    java.lang.String runnerId)
Finds build runner by its' id

Parameters:
runnerId - id of the runner
Returns:
build runner or null if runner with such id not found
Since:
6.0

findRunnerParameter

@Nullable
java.lang.String findRunnerParameter(@NotNull
                                              java.lang.String paramName)
Searches runner parameter in all build runners and returns value of the first found parameter with given name.

Parameters:
paramName - name of the parameter
Returns:
the first found parameter value or null
Since:
6.0

getBuildParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getBuildParameters()
Return map of build parameters specified by user. Each build parameter has name and value. Name of each parameter starts from a prefix: env. or system. Value may by either simple string, or may contain references to other parameters in form %env.HOME% or %system.os.name% or %system.agent.name%

Returns:
see above

getBuildParametersCollection

@NotNull
java.util.Collection<Parameter> getBuildParametersCollection()
Returns build parameters collection.

Returns:
see above

addBuildParameter

void addBuildParameter(Parameter parameter)
Adds build parameter to the configuration. Build parameter is a system or environment variable. Concrete parameter type is being selected by its name prefix. Constants.SYSTEM_PREFIX for system properties and Constants.ENV_PREFIX for environment variable.

Parameters:
parameter - specified parameter.

removeBuildParameter

void removeBuildParameter(java.lang.String paramName)
Removes existing build parameter by its name.

Parameters:
paramName - specified parameter name.

getBuildParameter

java.lang.String getBuildParameter(java.lang.String key)
Returns build parameter by parameter key

Parameters:
key - parameter key
Returns:
build parameter by parameter key

getVcsRoots

@NotNull
java.util.List<SVcsRoot> getVcsRoots()
Returns all roots currently attached to this configuration

Returns:
collection of all attached vcs roots.

addBuildTrigger

boolean addBuildTrigger(@NotNull
                        BuildTriggerDescriptor triggerDescriptor)
Adds new trigger to build configuration settings. Use BuildTriggerDescriptorFactory to create trigger descriptor.

Parameters:
triggerDescriptor - trigger descriptor
Returns:
true if trigger was added, and false if trigger with such id already exists
Since:
5.1

addBuildTrigger

@NotNull
BuildTriggerDescriptor addBuildTrigger(@NotNull
                                               java.lang.String type,
                                               @NotNull
                                               java.util.Map<java.lang.String,java.lang.String> params)
Adds new trigger of specified type and with specified parameters to build configuration settings.

Parameters:
type - type of the trigger
params - parameters map
Returns:
newly created trigger descriptor
Since:
7.0

removeBuildTrigger

boolean removeBuildTrigger(@NotNull
                           BuildTriggerDescriptor triggerDescriptor)
Removes specified build trigger from the settings

Parameters:
triggerDescriptor - trigger descriptor
Returns:
true if trigger was actually removed and false otherwise
Since:
5.1

updateBuildTrigger

boolean updateBuildTrigger(@NotNull
                           java.lang.String triggerId,
                           @NotNull
                           java.lang.String newType,
                           @NotNull
                           java.util.Map<java.lang.String,java.lang.String> newParams)
Updates build trigger descriptor with specified id, changes type and parameters.

Parameters:
triggerId - id of build trigger descriptor
newType - type of build trigger descriptor
newParams - parameters map
Returns:
true if parameters of build trigger descriptor were changed (descriptor with such id exists) and false otherwise
Since:
7.0

getBuildTriggersCollection

@NotNull
java.util.Collection<BuildTriggerDescriptor> getBuildTriggersCollection()
Returns collection of build trigger settings

Returns:
see above
Since:
5.1

findTriggerById

@Nullable
BuildTriggerDescriptor findTriggerById(@NotNull
                                                java.lang.String triggerId)
Finds build trigger descriptor by its' id

Parameters:
triggerId - id of the trigger
Returns:
build trigger descriptor or null if trigger with such id not found
Since:
6.0

setCheckoutType

void setCheckoutType(BuildTypeDescriptor.CheckoutType type)
Sets preferred checkout type for the configuration sources. Actual checkout type may differ, for example, if preferred checkout type is set to ON_AGENT, but there is vcs root which does not support on agent checkout, actual checkout type will be switched to ON_SERVER.
BuildTypeDescriptor.CheckoutType.ON_SERVER - checkout sources automatically on the server and snd it to the agent.
BuildTypeDescriptor.CheckoutType.ON_AGENT - checkout sources automatically on the agent.
BuildTypeDescriptor.CheckoutType.MANUAL - do not check out sources automatically.

Parameters:
type - new checkout type.

getCheckoutType

@NotNull
BuildTypeDescriptor.CheckoutType getCheckoutType()
Returns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself. This method returns actual checkout type, which may differ from the value set by setCheckoutType(jetbrains.buildServer.BuildTypeDescriptor.CheckoutType)

Returns:
method to get sources on agent.

setCheckoutDirectory

void setCheckoutDirectory(@Nullable
                          java.lang.String dir)
Sets build checkout directory. Set it to null to use default checkout directory.

Parameters:
dir - checkout directory

getCheckoutDirectory

@Nullable
java.lang.String getCheckoutDirectory()
Returns build checkout directory - if specified explicitly. Returns null if default checkout directory, generated by TeamCity should be used.

Returns:
build checkout directory

setArtifactPaths

void setArtifactPaths(@Nullable
                      java.lang.String artifactPaths)
Sets build artifact paths. Artifact paths are comma separated paths to build artifacts. Support ant-style wildcards and target directories like *.zip => winFiles,unix/dist.tgz => linuxFiles, where winFiles and linuxFiles are target directories. Set to null or empty string to disable artifacts processing.

Parameters:
artifactPaths - paths to build artifacts

getArtifactPaths

@Nullable
java.lang.String getArtifactPaths()
Returns build artifact paths.

Returns:
build artifact paths

getArtifactDependencies

@NotNull
java.util.List<SArtifactDependency> getArtifactDependencies()
Returns artifacts this build configuration depending on.

Returns:
list of artifacts this build configuration depending on

setArtifactDependencies

void setArtifactDependencies(@NotNull
                             java.util.List<SArtifactDependency> artifacts)
Sets artifacts this build configuration depending on.

Parameters:
artifacts - new artifacts dependency list.

containsVcsRoot

boolean containsVcsRoot(long vcsRootId)
Returns true if VCS root with specified is attached to the build configuration

Parameters:
vcsRootId - id of VCS root
Returns:
true if build configuration contains specified VCS root

getVcsRootEntries

@NotNull
java.util.List<VcsRootEntry> getVcsRootEntries()
Returns all entries of vcs roots. Each entry contains reference to root and its checkout rules.

Returns:
all entries of vcs roots for this configuration

addVcsRoot

boolean addVcsRoot(@NotNull
                   SVcsRoot root)
                   throws InvalidVcsRootScopeException,
                          VcsRootNotFoundException
Adds VCS root to the build configuration with default checkout rules.

Parameters:
root - VCS root to add
Returns:
true if VCS root was actually added and false otherwise (this VCS root already exists)
Throws:
InvalidVcsRootScopeException - if VCS root scope is local and corresponds to another project (not the project - owner of this build configuration)
VcsRootNotFoundException - if specified VCS root does not exist anymore

removeVcsRoot

boolean removeVcsRoot(@NotNull
                      SVcsRoot root)
Removes existing VCS root from the build configuration. If there were checkout rules attached to this VCS root they will be removed too.

Parameters:
root - VCS root to remove
Returns:
true if VCS root was actually removed from the build configuration and false if build configuration did not have this vcs root attached

setCheckoutRules

boolean setCheckoutRules(@NotNull
                         VcsRoot root,
                         @NotNull
                         CheckoutRules checkoutRules)
Sets checkout rules for specified VCS root. VCS root must be attached to this build configuration.

Parameters:
root - root to set rules for
checkoutRules - checkout rules for the VCS root
Returns:
true if checkout rules were set for the VCS root (if VCS root is attached) and false otherwise

getCheckoutRules

CheckoutRules getCheckoutRules(@NotNull
                               VcsRoot root)
Returns checkout rules configured for the specified VCS root. If there are no checkout rules or specified VCS root is not attached to this build configuration, null is returned.

Parameters:
root - VCS root
Returns:
checkout rules or null

addConfigParameter

void addConfigParameter(@NotNull
                        Parameter param)
Adds configuration parameter. There are three different types of parameters which can be added to build configuration settings:

Parameters:
param - configuration parameter

removeConfigParameter

void removeConfigParameter(@NotNull
                           java.lang.String paramName)
Removes configuration parameters with specified name

Parameters:
paramName - parameter name

getConfigParametersCollection

@NotNull
java.util.Collection<Parameter> getConfigParametersCollection()
Returns collection of configuration parameters.

Returns:
see above

getConfigParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getConfigParameters()
Returns map of configuration parameters

Returns:
see above

getUndefinedParameters

@NotNull
java.util.List<java.lang.String> getUndefinedParameters()
Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided. I.e. there is a reference to a parameter but such parameter is not defined anywhere.
Parameter value can come from different sources:

Returns:
see above
Since:
6.0

isTemplateBased

boolean isTemplateBased()
Returns true if these settings are based on a template

Returns:
see above

getTemplate

@Nullable
BuildTypeTemplate getTemplate()
Returns template these settings are based on.

Returns:
see above

getTemplateId

@Nullable
java.lang.String getTemplateId()
Returns id of the template if settings are template based and null otherwise

Returns:
see above

getRequirements

@NotNull
java.util.List<Requirement> getRequirements()
Get list of explicit requirements for build agents which can run this build configuration. Explicit requirements are specified by user in Web UI explicitly.

Returns:
see above

getImplicitRequirements

@NotNull
java.util.List<Requirement> getImplicitRequirements()
Get list of non-satisfied implicit requirements for build agents. Implicit requirements appear when some build configuration property, or run parameter contains a reference to another parameter in form %<param name>%.

Returns:
see above
See Also:
#getImplicitRequirements(java.util.Set

addRequirement

void addRequirement(@NotNull
                    Requirement requirement)
Adds new build requirement to the configuration.

Parameters:
requirement - new requirement.

removeRequirement

void removeRequirement(java.lang.String parameterName)
Removes requirement with the specified property name from the configuration.

Parameters:
parameterName - name of the requirement parameter.

getBuildNumberPattern

@NotNull
java.lang.String getBuildNumberPattern()
Returns current build number pattern

Returns:
see above
Since:
5.0

setBuildNumberPattern

void setBuildNumberPattern(@NotNull
                           java.lang.String pattern)
Sets build number pattern. %build.counter% in the pattern will be replaced with current build number value when build starts

Parameters:
pattern - pattern to set
Since:
5.0

persist

void persist()
Persists these settings.


replaceInValues

boolean replaceInValues(@NotNull
                        java.lang.String regexp,
                        @NotNull
                        java.lang.String replacement)
                        throws java.util.regex.PatternSyntaxException
Replaces values according to specified regexp and replacement string in all text parameters of the build configuration

Parameters:
regexp - regexp
replacement - replacement
Returns:
true if at least one text value was affected and false otherwise
Throws:
java.util.regex.PatternSyntaxException - if pattern is incorrect
Since:
5.1

addBuildFeature

@NotNull
SBuildFeatureDescriptor addBuildFeature(@NotNull
                                                java.lang.String type,
                                                @NotNull
                                                java.util.Map<java.lang.String,java.lang.String> params)
Adds build feature with specified type and parameters to this settings object.

Parameters:
type - build feature type
params - build feature parameters
Returns:
build feature descriptor
Since:
6.0

addBuildFeature

void addBuildFeature(@NotNull
                     SBuildFeatureDescriptor feature)
Adds build feature descriptor to this settings object.

Parameters:
feature - build feature descriptor
Since:
6.0

getBuildFeatures

@NotNull
java.util.Collection<SBuildFeatureDescriptor> getBuildFeatures()
Returns build features added to this settings object.

Returns:
collection of configured build features
Since:
6.0

removeBuildFeature

@Nullable
SBuildFeatureDescriptor removeBuildFeature(@NotNull
                                                    java.lang.String featureId)
Removes build feature with specified id from this settings object.

Parameters:
featureId - id of the feature
Returns:
removed build feature descriptor or null if there were no feature descriptor with such id
Since:
6.0

updateBuildFeature

boolean updateBuildFeature(@NotNull
                           java.lang.String featureId,
                           @NotNull
                           java.lang.String newType,
                           @NotNull
                           java.util.Map<java.lang.String,java.lang.String> newParams)
Updates build feature descriptor with specified id, changes type and parameters.

Parameters:
featureId - id of build feature descriptor
newType - type of build feature descriptor
newParams - parameters map
Returns:
true if parameters of build feature descriptor were changed (descriptor with such id exists) and false otherwise
Since:
6.0

setEnabled

void setEnabled(@NotNull
                java.lang.String parametersDescriptorId,
                boolean enabled)
Enables or disables descriptor with specified id in build configuration settings. This method can be used to enable or disable build runners, triggers and build features.

Parameters:
parametersDescriptorId - id of build runner, trigger or build feature
enabled - true to enable, false to disable
Since:
7.0

isEnabled

boolean isEnabled(@NotNull
                  java.lang.String parametersDescriptorId)
Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.

Parameters:
parametersDescriptorId - id of build runner, trigger or build feature
Since:
7.0