Package hudson.model

Class StringParameterValue

java.lang.Object
hudson.model.ParameterValue
hudson.model.StringParameterValue
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TextParameterValue

public class StringParameterValue extends ParameterValue
See Also:
  • Field Details

    • value

      @Exported(visibility=4) @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public String value
  • Constructor Details

    • StringParameterValue

      @DataBoundConstructor public StringParameterValue(String name, String value)
    • StringParameterValue

      public StringParameterValue(String name, String value, String description)
  • Method Details

    • 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.
    • getValue

      public String 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
    • doTrim

      public void doTrim()
      Trimming for value
      Since:
      2.90
    • hashCode

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

      public boolean equals(Object obj)
      Overrides:
      equals 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