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

public @Interface FactoryComponent

extends Annotation
Known Direct Implementers
org.osgi.service.cdi.annotations.FactoryComponent.Literal
Annotations
@ComponentScoped
@Documented
@Named
@Retention:RUNTIME
@Stereotype
@Target:TYPE
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME
Identifies a factory component.

Factory components MUST always be ComponentScoped. Applying any other scope will result in a definition error.

Author
$Id: 3ec1e11fe049cfaa25cfa28abddd84fec2148669 $
See Also
Factory Component

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FactoryComponent.Literal

Support inline instantiation of the FactoryComponent annotation.

Method Summary

Modifier and TypeMethod and Description
public String
value()

The configuration PID for the configuration of this Component.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

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: 

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

public final Class FactoryComponent.Literal

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

Field Summary

Modifier and TypeField and Description
private final String
_pid

private static final long
serialVersionUID

Hides javax.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Summary

AccessConstructor and Description
private
Literal(String pid)

Method Summary

Modifier and TypeMethod and Description
public static final FactoryComponent.Literal

Returns:

an instance of FactoryComponent
of(String
the factory configuration pid
pid)

public String
value()

Implements org.osgi.service.cdi.annotations.FactoryComponent.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
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Detail

Literalback to summary
private Literal(String pid)

Method Detail

ofback to summary
public static final FactoryComponent.Literal of(String pid)
Parameters
pid:String

the factory configuration pid

Returns:FactoryComponent.Literal

an instance of FactoryComponent

valueback to summary
public String value()

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

Doc from org.osgi.service.cdi.annotations.FactoryComponent.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: 

@FactoryPID(CDI_COMPONENT_NAME)
Annotations
@Override