com.sun.jersey.spi.service
Enum ComponentProvider.Scope

java.lang.Object
  extended by java.lang.Enum<ComponentProvider.Scope>
      extended by com.sun.jersey.spi.service.ComponentProvider.Scope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ComponentProvider.Scope>
Enclosing interface:
ComponentProvider

public static enum ComponentProvider.Scope
extends java.lang.Enum<ComponentProvider.Scope>

The scope contract for the instantiation of a component.


Enum Constant Summary
PerRequest
          Declares that the scope is application defined and instances will be managed by the runtime according to this scope.
Singleton
          Declares that only one instance of a component shall exist per-runtime instance.
Undefined
          The runtime does not care what the scope is, the component provider can decide which to choose - the component provider is responsible for managing instances of a type.
 
Field Summary
static java.util.List<ComponentProvider.Scope> PERREQUEST_UNDEFINED
          A immutable list comprising of the scopes PerRequest and Undefined, in that order.
static java.util.List<ComponentProvider.Scope> PERREQUEST_UNDEFINED_SINGLETON
          A immutable list comprising of the scopes PerRequest, Undefined and Singleton, in that order.
static java.util.List<ComponentProvider.Scope> UNDEFINED_SINGLETON
          A immutable list comprising of the scopes Undefined and Singleton, in that order.
 
Method Summary
static ComponentProvider.Scope valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ComponentProvider.Scope[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Singleton

public static final ComponentProvider.Scope Singleton
Declares that only one instance of a component shall exist per-runtime instance.


PerRequest

public static final ComponentProvider.Scope PerRequest
Declares that the scope is application defined and instances will be managed by the runtime according to this scope. This requires that a new instance be created for each invocation of getInstance.


Undefined

public static final ComponentProvider.Scope Undefined
The runtime does not care what the scope is, the component provider can decide which to choose - the component provider is responsible for managing instances of a type.

Field Detail

UNDEFINED_SINGLETON

public static final java.util.List<ComponentProvider.Scope> UNDEFINED_SINGLETON
A immutable list comprising of the scopes Undefined and Singleton, in that order.


PERREQUEST_UNDEFINED_SINGLETON

public static final java.util.List<ComponentProvider.Scope> PERREQUEST_UNDEFINED_SINGLETON
A immutable list comprising of the scopes PerRequest, Undefined and Singleton, in that order.


PERREQUEST_UNDEFINED

public static final java.util.List<ComponentProvider.Scope> PERREQUEST_UNDEFINED
A immutable list comprising of the scopes PerRequest and Undefined, in that order.

Method Detail

values

public static final ComponentProvider.Scope[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ComponentProvider.Scope c : ComponentProvider.Scope.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ComponentProvider.Scope valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.