Package hudson.model

Class BooleanParameterValue

java.lang.Object
hudson.model.ParameterValue
hudson.model.BooleanParameterValue
All Implemented Interfaces:
Serializable

public class BooleanParameterValue extends ParameterValue
See Also:
  • Field Details

    • value

      @Exported(visibility=4) public final boolean value
  • Constructor Details

    • BooleanParameterValue

      @DataBoundConstructor public BooleanParameterValue(String name, boolean value)
    • BooleanParameterValue

      public BooleanParameterValue(String name, boolean value, String description)
  • Method Details

    • getValue

      public Boolean getValue()
      Description copied from class: ParameterValue
      Returns the most natural Java object that represents the actual value, like boolean, string, etc.
      Overrides:
      getValue in class ParameterValue
      Returns:
      if there is no natural value for this parameter type, this may be used; null may be used when the value is normally defined but missing in this case for various reasons
    • buildEnvironment

      public void buildEnvironment(Run<?,?> build, EnvVars env)
      Exposes the name/value as an environment variable.
      Overrides:
      buildEnvironment in class ParameterValue
      Parameters:
      build - The build for which this parameter is being used. Never null.
      env - never null.
    • createVariableResolver

      public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)
      Description copied from class: ParameterValue
      Returns a VariableResolver so that other components like Builders can perform variable substitution to reflect parameter values into the build process.

      This is yet another means in which a ParameterValue can influence a build.

      Overrides:
      createVariableResolver in class ParameterValue
      Parameters:
      build - The build for which this parameter is being used. Never null.
      Returns:
      if the parameter value is not interested in participating to the variable replacement process, return VariableResolver.NONE.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ParameterValue
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ParameterValue
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getShortDescription

      public String getShortDescription()
      Description copied from class: ParameterValue
      Computes a human-readable possible-localized one-line description of the parameter value.

      This message is used as a tooltip to describe jobs in the queue. The text should be one line without new line. No HTML allowed (the caller will perform necessary HTML escapes, so any text can be returned.)

      Overrides:
      getShortDescription in class ParameterValue