ParameterizedSelfPromotionCondition (Jenkins promoted builds plugin 945.v597f5c6a_d3fd API)

java.lang.Object
- hudson.plugins.promoted_builds.PromotionCondition
- - hudson.plugins.promoted_builds.conditions.SelfPromotionCondition
  - - hudson.plugins.promoted_builds.conditions.ParameterizedSelfPromotionCondition

All Implemented Interfaces:

ExtensionPoint, Describable<PromotionCondition>
```
public class ParameterizedSelfPromotionCondition
extends SelfPromotionCondition
```
PromotionCondition that promotes a build as soon as it's done if a given parameter has the specified value.

Author:

Grant Limberg (glimberg at gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ParameterizedSelfPromotionCondition.DescriptorImpl
- Nested classes/interfaces inherited from class hudson.plugins.promoted_builds.conditions.SelfPromotionCondition
  SelfPromotionCondition.RunListenerImpl
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor	Description
`ParameterizedSelfPromotionCondition(boolean evenIfUnstable, String parameterName, String parameterValue)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getParameterName()`
`String`	`getParameterValue()`
`PromotionBadge`	`isMet(PromotionProcess promotionProcess, AbstractBuild<?,?> build)`	Checks if the promotion criteria is met.

Methods inherited from class hudson.plugins.promoted_builds.conditions.SelfPromotionCondition
isEvenIfUnstable

Methods inherited from class hudson.plugins.promoted_builds.PromotionCondition
all, getApplicableTriggers, getDescriptor, isMet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParameterizedSelfPromotionCondition
```
@DataBoundConstructor
public ParameterizedSelfPromotionCondition(boolean evenIfUnstable,
                                           String parameterName,
                                           String parameterValue)
```
- Method Detail
  - getParameterName
```
public String getParameterName()
```
  - getParameterValue
```
public String getParameterValue()
```
  - isMet
```
public PromotionBadge isMet(PromotionProcess promotionProcess,
                            AbstractBuild<?,?> build)
```
    Description copied from class: PromotionCondition
    
    Checks if the promotion criteria is met.
    
    Overrides:
    
    isMet in class SelfPromotionCondition
    
    Parameters:
    
    promotionProcess - The promotion process being evaluated for qualification
    
    build - The build for which the promotion is considered.
    
    Returns:
    
    non-null if the promotion condition is met. This object is then recorded so that we know how a build was promoted. Null if otherwise, meaning it shouldn't be promoted.