Interface SelectionProperty


public interface SelectionProperty
Represents a deferred binding property. The deferred binding property may or may not have a single value applied across all permutations. SelectionProperty implementations must support object identity comparisons.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the fallback value or an empty string if not defined.
    Returns the name of the deferred binding property.
    Returns all possible values for this deferred binding property.
    Returns a raw function body that provides the runtime value to be used for a deferred binding property.
    boolean
    Returns true if the value of the SelectionProperty is always derived from other SelectionProperties and, as a consequence, the property provider never needs to be evaluated.
    Returns the defined value for the deferred binding property or null if the value of the property is not constant.
  • Method Details

    • getFallbackValue

      String getFallbackValue()
      Returns the fallback value or an empty string if not defined.
    • getName

      String getName()
      Returns the name of the deferred binding property.
    • getPossibleValues

      SortedSet<String> getPossibleValues()
      Returns all possible values for this deferred binding property.
    • getPropertyProvider

      String getPropertyProvider(TreeLogger logger, SortedSet<ConfigurationProperty> configProperties) throws UnableToCompleteException
      Returns a raw function body that provides the runtime value to be used for a deferred binding property.
      Parameters:
      logger - logger to use for any warnings/errors
      configProperties - set of configuration properties
      Throws:
      UnableToCompleteException - if execution cannot continue, after having logged a message
    • isDerived

      boolean isDerived()
      Returns true if the value of the SelectionProperty is always derived from other SelectionProperties and, as a consequence, the property provider never needs to be evaluated.
    • tryGetValue

      String tryGetValue()
      Returns the defined value for the deferred binding property or null if the value of the property is not constant.
      See Also: