Package org.osgi.service.cdi

Enum Class ServiceScope

java.lang.Object

java.lang.Enum<ServiceScope>

org.osgi.service.cdi.ServiceScope

All Implemented Interfaces:

Serializable, Comparable<ServiceScope>, Constable

public enum ServiceScope
extends Enum<ServiceScope>

Possible values for ActivationTemplateDTO.scope.

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
BUNDLE	This activation will register an OSGi service with service.scope=bundle.
PROTOTYPE	This activation will register an OSGi service with service.scope=prototype.
SINGLETON	This activation will only ever create one instance

Method Summary

Modifier and Type	Method	Description
static ServiceScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServiceScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLETON

public static final ServiceScope SINGLETON

This activation will only ever create one instance

The instance is created after the parent component becomes satisfied and is destroyed before the parent component becomes unsatisfied.

If ActivationTemplateDTO.serviceClasses is not empty the instance will be registered as an OSGi service with service.scope=singleton.

BUNDLE

public static final ServiceScope BUNDLE

This activation will register an OSGi service with service.scope=bundle.

The service is registered just after all SINGLETON activations are set up and just before all SINGLETON activations are torn down.

The ActivationTemplateDTO.serviceClasses is not empty when this scope is used.

PROTOTYPE

public static final ServiceScope PROTOTYPE

This activation will register an OSGi service with service.scope=prototype.

The service is registered just after all SINGLETON activations are set up and just before all SINGLETON activations are torn down.

The ActivationTemplateDTO.serviceClasses is not empty when this scope is used.

Method Details

values

public static ServiceScope[] 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 ServiceScope 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