Enum Class ConfigurationPolicy

java.lang.Object
java.lang.Enum<ConfigurationPolicy>
aQute.bnd.component.annotations.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.

Since:
1.1
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Always allow the component configuration to be satisfied and do not use the corresponding Configuration object even if it is present.
    Use the corresponding Configuration object if present but allow the component to be satisfied even if the corresponding Configuration object is not present.
    There must be a corresponding Configuration object for the component configuration to become satisfied.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
     
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • OPTIONAL

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

      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.
  • Field Details

    • value

      private final String value
  • Constructor Details

    • ConfigurationPolicy

      private ConfigurationPolicy(String value)
  • Method Details

    • values

      public static ConfigurationPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

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