Package com.broadleafcommerce.common.extension

Annotation Type ConditionalOnPropertyOrGroup

@Retention(RUNTIME) @Target({TYPE,METHOD}) @Documented @Conditional(com.broadleafcommerce.common.extension.OnPropertyOrGroupCondition.class) public @interface ConditionalOnPropertyOrGroup

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    group
    The blanket property that covers a group of conditions.
    String[]
    name
    The name of the properties to test.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    havingValue
    The string representation of the expected value for the properties.
    boolean
    matchIfMissing
    Specify if the condition should match if the property is not set.
    String
    prefix
    A prefix that should be applied to each property.

  • Element Details

    • name

      String[] name
      The name of the properties to test. If a prefix has been defined, it is applied to compute the full key of each property. For instance if the prefix is app.config and one value is my-value, the full key would be app.config.my-value

      Use the dashed notation to specify each property, that is all lower case with a "-" to separate words (e.g. my-long-property).

      Returns:
      the names

    • group

      String group
      The blanket property that covers a group of conditions. If any of the properties specified in name() are explicitly defined in the system, the blanket property is ignored.
      Returns:
      The blanket property that covers a group of conditions

    • prefix

      String prefix
      A prefix that should be applied to each property. The prefix automatically ends with a dot if not specified. A valid prefix is defined by one or more words separated with dots (e.g. "acme.system.feature").
      Returns:
      the prefix
      Default:
      ""

    • havingValue

      String havingValue
      The string representation of the expected value for the properties. If not specified, the property must not be equal to false.
      Returns:
      the expected value
      Default:
      ""

    • matchIfMissing

      boolean matchIfMissing
      Specify if the condition should match if the property is not set. Defaults to false.
      Returns:
      if should match if the property is missing
      Default:
      false