org.omnifaces.config

Enum BeanManager

java.lang.Object

java.lang.Enum<BeanManager>

org.omnifaces.config.BeanManager

All Implemented Interfaces:

Serializable, Comparable<BeanManager>

public enum BeanManager
extends Enum<BeanManager>

This configuration enum allows you to get a reference to CDI managed beans without having any direct CDI dependency. It will during initialization grab the CDI bean manager instance from JNDI and if it's not null, then it's using reflection to get and store the necessary methods in the enum instance which are then invoked on instance methods such as getReference().

Usage

 // Get the CDI managed bean instance of the given bean class.
 SomeBean someBean = BeanManager.INSTANCE.getReference(SomeBean.class);
 

If you however already have a CDI bean manager instance at hands via @Inject, use BeansLocal.getReference(javax.enterprise.inject.spi.BeanManager, Class) instead.

Since:

1.6.1

Author:

Bauke Scholtz

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Returns the lazily loaded enum singleton instance.

Method Summary

Modifier and Type	Method and Description
<T> T	get() Returns the CDI bean manager.
<T> T	getReference(Class<T> beanClass) Returns the CDI managed bean reference (proxy) of the given class.
static BeanManager	valueOf(String name) Returns the enum constant of this type with the specified name.
static BeanManager[]	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

INSTANCE

public static final BeanManager INSTANCE

Returns the lazily loaded enum singleton instance. Throws IllegalStateException when initialization fails.

Method Detail

values

public static BeanManager[] 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 (BeanManager c : BeanManager.values())
    System.out.println(c);

Returns:

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

valueOf

public static BeanManager 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

get

public <T> T get()

Returns the CDI bean manager.

Type Parameters:

T - The javax.enterprise.inject.spi.BeanManager.

Returns:

The CDI bean manager.

Throws:

ClassCastException - When you assign it to a variable which is not declared as CDI BeanManager.

getReference

public <T> T getReference(Class<T> beanClass)

Returns the CDI managed bean reference (proxy) of the given class. Note that this actually returns a client proxy and the underlying actual instance is thus always auto-created.

Type Parameters:

T - The expected return type.

Parameters:

beanClass - The CDI managed bean class.

Returns:

The CDI managed bean reference (proxy) of the given class, or null if there is none.

Throws:

UnsupportedOperationException - When obtaining the CDI managed bean reference failed with an exception.