OSGi 8.1.0 · org.osgi.service.component.annotations.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.

Field Summary

Modifier and Type	Field and Description
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.
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.
private final String	value

Constructor Summary

Access	Constructor and Description
private	ConfigurationPolicy(String value)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static ConfigurationPolicy	valueOf(String name)
public static ConfigurationPolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

IGNORE	back to summary
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.

OPTIONAL	back to summary
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	back to summary
public static final ConfigurationPolicy REQUIRE There must be a corresponding Configuration object for the component configuration to become satisfied.

value	back to summary
private final String value

Constructor Detail

ConfigurationPolicy	back to summary
private ConfigurationPolicy(String value)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static ConfigurationPolicy valueOf(String name)

values	back to summary
public static ConfigurationPolicy[] values()