Package com.thoughtworks.go.plugin.api.config

Class Property

java.lang.Object
com.thoughtworks.go.plugin.api.config.Property
Direct Known Subclasses:
PackageMaterialProperty, TaskConfigProperty
@Deprecated
public class Property
extends java.lang.Object
Deprecated.
Represents single configuration property. A given property can have set of metadata which can be represented by options. The valid options are Property.REQUIRED, Property.PART_OF_IDENTITY, Property.SECURE, Property.DISPLAY_NAME and Property.DISPLAY_ORDER

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Option<java.lang.String> DISPLAY_NAME
    Deprecated.
    Option to specify the display name for the property
    static Option<java.lang.Integer> DISPLAY_ORDER
    Deprecated.
    Option to specify order of display of property on screen
    static Option<java.lang.Boolean> PART_OF_IDENTITY
    Deprecated.
    Option to specify if a property is part of group of properties used to uniquely identify material
    static Option<java.lang.Boolean> REQUIRED
    Deprecated.
    Option to specify if a property is a mandatory when configuration is captured
    static Option<java.lang.Boolean> SECURE
    Deprecated.
    Option to specify if a property is a secure property.

  • Constructor Summary

    Constructors
    Modifier Constructor Description
      Property​(java.lang.String key)
    Deprecated.
     
    protected Property​(java.lang.String key, java.lang.String value)
    Deprecated.
     
      Property​(java.lang.String key, java.lang.String value, java.lang.String defaultValue)
    Deprecated.
     

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getKey()
    Deprecated.
    Gets property key
    <T> T getOption​(Option<T> option)
    Deprecated.
    Gets value for given option
    Options getOptions()
    Deprecated.
    Gets all options of property
    java.lang.String getValue()
    Deprecated.
    Gets property value.
    <T> Property with​(Option<T> option, T value)
    Deprecated.
    Adds an option
    Property withDefault​(java.lang.String defaultValue)
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • REQUIRED

      public static final Option<java.lang.Boolean> REQUIRED
      Deprecated.
      Option to specify if a property is a mandatory when configuration is captured

    • PART_OF_IDENTITY

      public static final Option<java.lang.Boolean> PART_OF_IDENTITY
      Deprecated.
      Option to specify if a property is part of group of properties used to uniquely identify material

    • SECURE

      public static final Option<java.lang.Boolean> SECURE
      Deprecated.
      Option to specify if a property is a secure property. If the property is secure, property value will be always stored (in configuration) and displayed in encrypted text

    • DISPLAY_NAME

      public static final Option<java.lang.String> DISPLAY_NAME
      Deprecated.
      Option to specify the display name for the property

    • DISPLAY_ORDER

      public static final Option<java.lang.Integer> DISPLAY_ORDER
      Deprecated.
      Option to specify order of display of property on screen

  • Constructor Details

    • Property

      public Property​(java.lang.String key)
      Deprecated.

    • Property

      protected Property​(java.lang.String key, java.lang.String value)
      Deprecated.

    • Property

      public Property​(java.lang.String key, java.lang.String value, java.lang.String defaultValue)
      Deprecated.

  • Method Details

    • getKey

      public java.lang.String getKey()
      Deprecated.
      Gets property key
      Returns:
      property key

    • with

      public final <T> Property with​(Option<T> option, T value)
      Deprecated.
      Adds an option
      Type Parameters:
      T - Type of option value
      Parameters:
      option - Option type to be added
      value - Option value
      Returns:
      current property instance (this)

    • getValue

      public java.lang.String getValue()
      Deprecated.
      Gets property value.
      Returns:
      property value

    • getOption

      public <T> T getOption​(Option<T> option)
      Deprecated.
      Gets value for given option
      Type Parameters:
      T - type of option
      Parameters:
      option - for which value needs to fetched
      Returns:
      option value

    • getOptions

      public Options getOptions()
      Deprecated.
      Gets all options of property
      Returns:
      all options of property

    • withDefault

      public Property withDefault​(java.lang.String defaultValue)
      Deprecated.