Enum Class ConfigurationPolicy

All Implemented Interfaces:
Serializable, Comparable<ConfigurationPolicy>, Constable

public enum ConfigurationPolicy extends Enum<ConfigurationPolicy>
Configuration Policy for the Component annotation.

Controls whether component configurations must be satisfied depending on the presence of a corresponding Configuration object in the OSGi Configuration Admin service. A corresponding configuration is a Configuration object where the PID is the name of the component.

  • Enum Constant Details


      public static final ConfigurationPolicy OPTIONAL
      Use the corresponding Configuration object if present but allow the component to be satisfied even if the corresponding Configuration object is not present.

      public static final ConfigurationPolicy REQUIRE
      There must be a corresponding Configuration object for the component configuration to become satisfied.
    • IGNORE

      public static final ConfigurationPolicy IGNORE
      Always allow the component configuration to be satisfied and do not use the corresponding Configuration object even if it is present.
  • Method Details

    • values

      public static ConfigurationPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ConfigurationPolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      toString in class Enum<ConfigurationPolicy>