org.eclipse.sisu.space

Enum BeanScanning

java.lang.Object

java.lang.Enum<BeanScanning>

org.eclipse.sisu.space.BeanScanning

All Implemented Interfaces:

Serializable, Comparable<BeanScanning>

public enum BeanScanning
extends Enum<BeanScanning>

Common techniques for discovering bean implementations.

See Also:

SpaceModule

Enum Constant Summary

Enum Constants

Enum Constant and Description
CACHE Scan once and cache results
GLOBAL_INDEX Use global index (application)
INDEX Use local index (plug-ins)
OFF Never scan
ON Always scan

Method Summary

Methods

Modifier and Type	Method and Description
static BeanScanning	select(Map<?,?> properties) Selects the property named "org.eclipse.sisu.space.BeanScanning" and attempts to map its value to a BeanScanning literal, ignoring case.
static BeanScanning	valueOf(String name) Returns the enum constant of this type with the specified name.
static BeanScanning[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ON

public static final BeanScanning ON

Always scan

OFF

public static final BeanScanning OFF

Never scan

CACHE

public static final BeanScanning CACHE

Scan once and cache results

INDEX

public static final BeanScanning INDEX

Use local index (plug-ins)

GLOBAL_INDEX

public static final BeanScanning GLOBAL_INDEX

Use global index (application)

Method Detail

values

public static BeanScanning[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BeanScanning c : BeanScanning.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BeanScanning valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

select

public static BeanScanning select(Map<?,?> properties)
                           throws IllegalArgumentException

Selects the property named "org.eclipse.sisu.space.BeanScanning" and attempts to map its value to a BeanScanning literal, ignoring case. Defaults to ON for blank or null values.

Parameters:

properties - The properties

Returns:

Selected scanning option

Throws:

IllegalArgumentException - if the property value cannot be mapped