Top Description Inners Methods
org.osgi.service.cdi.annotations

public @Interface PID

extends Annotation
Known Direct Implementers
org.osgi.service.cdi.annotations.PID.Literal
Annotations
@Documented
@Qualifier
@Repeatable:PIDs
@Retention:RUNTIME
@Target:FIELD, METHOD, PARAMETER, TYPE
Static Imports
java.lang.annotation.ElementType.FIELD, .ElementType.METHOD, .ElementType.PARAMETER, .ElementType.TYPE, .RetentionPolicy.RUNTIME
Annotation used in collaboration with ComponentScoped to specify singleton configurations and their policy.
Author
$Id: 6a1aba88c591f02759e28afd80ff6bcdb49156d0 $

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PID.Literal

Support inline instantiation of the PID annotation.

Method Summary

Modifier and TypeMethod and Description
public ConfigurationPolicy
policy()

The configuration policy associated with this PID.

public String
value()

The configuration PID for the configuration of this Component.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

policyback to summary
public ConfigurationPolicy policy()

The configuration policy associated with this PID.

Controls how the configuration must be satisfied depending on the presence and type of a corresponding Configuration object in the OSGi Configuration Admin service. Corresponding configuration is a Configuration object where the PID is equal to value.

If not specified, the configuration is not required.

valueback to summary
public String value()

The configuration PID for the configuration of this Component.

The value specifies a configuration PID who's configuration properties are available at injection points in the component.

A special string ("$") can be used to specify the name of the component as a configuration PID. The CDI_COMPONENT_NAME constant holds this special string.

For example: 

@PID(CDI_COMPONENT_NAME)
org.osgi.service.cdi.annotations back to summary

public final Class PID.Literal

extends AnnotationLiteral<PID>
implements PID
Class Inheritance
All Implemented Interfaces
org.osgi.service.cdi.annotations.PID, java.lang.annotation.Annotation
Support inline instantiation of the PID annotation.

Field Summary

Modifier and TypeField and Description
private final String
_pid

private final ConfigurationPolicy
_policy

private static final long
serialVersionUID

Hides javax.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Summary

AccessConstructor and Description
private
Literal(String pid, ConfigurationPolicy policy)

Method Summary

Modifier and TypeMethod and Description
public static final PID.Literal

Returns:

an instance of PID
of(String
the configuration pid
pid, ConfigurationPolicy
the policy of the configuration
policy)

public ConfigurationPolicy
policy()

Implements org.osgi.service.cdi.annotations.PID.policy.

The configuration policy associated with this PID.

public String
value()

Implements org.osgi.service.cdi.annotations.PID.value.

The configuration PID for the configuration of this Component.

Inherited from javax.enterprise.util.AnnotationLiteral:
annotationTypeequalshashCodetoString

Field Detail

_pidback to summary
private final String _pid
_policyback to summary
private final ConfigurationPolicy _policy
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Detail

Literalback to summary
private Literal(String pid, ConfigurationPolicy policy)

Method Detail

ofback to summary
public static final PID.Literal of(String pid, ConfigurationPolicy policy)
Parameters
pid:String

the configuration pid

policy:ConfigurationPolicy

the policy of the configuration

Returns:PID.Literal

an instance of PID

policyback to summary
public ConfigurationPolicy policy()

Implements org.osgi.service.cdi.annotations.PID.policy.

Doc from org.osgi.service.cdi.annotations.PID.policy.

The configuration policy associated with this PID.

Controls how the configuration must be satisfied depending on the presence and type of a corresponding Configuration object in the OSGi Configuration Admin service. Corresponding configuration is a Configuration object where the PID is equal to value.

If not specified, the configuration is not required.

Annotations
@Override
valueback to summary
public String value()

Implements org.osgi.service.cdi.annotations.PID.value.

Doc from org.osgi.service.cdi.annotations.PID.value.

The configuration PID for the configuration of this Component.

The value specifies a configuration PID who's configuration properties are available at injection points in the component.

A special string ("$") can be used to specify the name of the component as a configuration PID. The CDI_COMPONENT_NAME constant holds this special string.

For example: 

@PID(CDI_COMPONENT_NAME)
Annotations
@Override