Beans (Omnifaces 2.0-RC1 API)

java.lang.Object
- org.omnifaces.util.Beans

@Typed
public final class Beans
extends Object

Collection of utility methods for the CDI API that are mainly shortcuts for obtaining stuff from the BeanManager.

Usage

Some examples:

 // Get the CDI managed bean reference (proxy) of the given bean class.
 SomeBean someBean = Beans.getReference(SomeBean.class);

 // Get the CDI managed bean instance (actual) of the given bean class.
 SomeBean someBean = Beans.getInstance(SomeBean.class);

 // Get all currently active CDI managed bean instances in the session scope.
 Map activeSessionScopedBeans = Beans.getActiveInstances(SessionScope.class);

 // Destroy any currently active CDI managed bean instance of given bean class.
 Beans.destroy(SomeBean.class);

The "native" CDI way would otherwise look like this:

 // Get the CDI managed bean reference (proxy) of the given bean class.
 Set<Bean<?>> beans = beanManager.getBeans(SomeBean.class);
 Bean<SomeBean> bean = (Bean<SomeBean>) beanManager.resolve(beans);
 CreationalContext<SomeBean> context = beanManager.createCreationalContext(bean);
 SomeBean someBean = (SomeBean) beanManager.getReference(bean, SomeBean.class, context);

If you need a dependency-free way of obtaining the CDI managed bean instance (e.g. when you want to write code which should also run on Tomcat), use BeanManager enum instead.

Since:: 1.6.1
Author:: Bauke Scholtz
See Also:: BeansLocal

Constructor Summary

Constructors
Constructor and Description

Beans()

Constructors
Constructor and Description
`Beans()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> void`	`destroy(javax.enterprise.inject.spi.Bean<T> bean)` Destroy the currently active instance of the given CDI managed bean representation.
`static <T> void`	`destroy(Class<T> beanClass)` Destroy the currently active instance of the given CDI managed bean class.
`static <S extends javax.enterprise.context.NormalScope> Map<Object,String>`	`getActiveInstances(Class<S> scope)` Returns all active CDI managed bean instances in the given CDI managed bean scope.
`static <A extends Annotation> A`	`getAnnotation(javax.enterprise.inject.spi.Annotated annotated, Class<A> annotationType)` Get program element annotation of a certain annotation type.
`static <T> T`	`getInstance(javax.enterprise.inject.spi.Bean<T> bean, boolean create)` Returns the CDI managed bean instance of the given resolved bean from the given bean manager and creates one if one doesn't exist and `create` argument is `true`, otherwise don't create one and return `null` if there's no current instance.
`static <T> T`	`getInstance(Class<T> beanClass)` Returns the CDI managed bean instance (actual) of the given class and creates one if one doesn't exist.
`static <T> T`	`getInstance(Class<T> beanClass, boolean create)` Returns the CDI managed bean instance (actual) of the given class and creates one if one doesn't exist and `create` argument is `true`, otherwise don't create one and return `null` if there's no current instance.
`static javax.enterprise.inject.spi.BeanManager`	`getManager()` Returns the CDI bean manager.
`static <T> T`	`getReference(javax.enterprise.inject.spi.Bean<T> bean)` Returns the CDI managed bean reference (proxy) of the given bean.
`static <T> T`	`getReference(Class<T> beanClass)` Returns the CDI managed bean reference (proxy) of the given class.
`static <T> javax.enterprise.inject.spi.Bean<T>`	`resolve(Class<T> beanClass)` Returns the CDI managed bean representation of the given bean class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Beans
```
public Beans()
```
- Method Detail
  - getManager
```
public static javax.enterprise.inject.spi.BeanManager getManager()
```
    Returns the CDI bean manager.
    
    Returns:
    The CDI bean manager.
    Since:
    
    2.0
  - resolve
```
public static <T> javax.enterprise.inject.spi.Bean<T> resolve(Class<T> beanClass)
```
    Returns the CDI managed bean representation of the given bean class.
    
    Type Parameters:
    T - The generic CDI managed bean type.
    Parameters:
    beanClass - The CDI managed bean class.
    
    Returns:
    The CDI managed bean representation of the given bean class, or null if there is none.
  - getReference
```
public static <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.
  - getReference
```
public static <T> T getReference(javax.enterprise.inject.spi.Bean<T> bean)
```
    Returns the CDI managed bean reference (proxy) of the given bean. 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:
    bean - The CDI managed bean representation.
    
    Returns:
    The CDI managed bean reference (proxy) of the given bean, or null if there is none.
  - getInstance
```
public static <T> T getInstance(Class<T> beanClass)
```
    Returns the CDI managed bean instance (actual) of the given class and creates one if one doesn't exist.
    
    Type Parameters:
    T - The expected return type.
    Parameters:
    beanClass - The CDI managed bean class.
    
    Returns:
    The CDI managed bean instance (actual) of the given class, or null if there is none.
    Since:
    
    1.8
  - getInstance
```
public static <T> T getInstance(Class<T> beanClass,
                boolean create)
```
    Returns the CDI managed bean instance (actual) of the given class and creates one if one doesn't exist and create argument is true, otherwise don't create one and return null if there's no current instance.
    
    Type Parameters:
    T - The expected return type.
    Parameters:
    beanClass - The CDI managed bean class.
    create - Whether to create create CDI managed bean instance if one doesn't exist.
    
    Returns:
    The CDI managed bean instance (actual) of the given class, or null if there is none and/or the create argument is false.
    Since:
    
    1.7
  - getInstance
```
public static <T> T getInstance(javax.enterprise.inject.spi.Bean<T> bean,
                boolean create)
```
    Returns the CDI managed bean instance of the given resolved bean from the given bean manager and creates one if one doesn't exist and create argument is true, otherwise don't create one and return null if there's no current instance.
    
    Type Parameters:
    T - The expected return type.
    Parameters:
    bean - The CDI managed bean representation.
    create - Whether to create create CDI managed bean instance if one doesn't exist.
    
    Returns:
    The CDI managed bean instance (actual) of the given bean, or null if there is none and/or the create argument is false.
    Since:
    
    1.7
  - getActiveInstances
```
public static <S extends javax.enterprise.context.NormalScope> Map<Object,String> getActiveInstances(Class<S> scope)
```
    Returns all active CDI managed bean instances in the given CDI managed bean scope. The map key represents the active CDI managed bean instance and the map value represents the CDI managed bean name, if any.
    
    Type Parameters:
    S - The generic CDI managed bean scope type.
    Parameters:
    scope - The CDI managed bean scope, e.g. RequestScoped.class.
    
    Returns:
    All active CDI managed bean instances in the given CDI managed bean scope.
    Since:
    
    1.7
  - destroy
```
public static <T> void destroy(Class<T> beanClass)
```
    Destroy the currently active instance of the given CDI managed bean class.
    
    Parameters:
    beanClass - The CDI managed bean class.
    Since:
    
    2.0
  - destroy
```
public static <T> void destroy(javax.enterprise.inject.spi.Bean<T> bean)
```
    Destroy the currently active instance of the given CDI managed bean representation.
    
    Parameters:
    bean - The CDI managed bean representation.
    Since:
    
    2.0
  - getAnnotation
```
public static <A extends Annotation> A getAnnotation(javax.enterprise.inject.spi.Annotated annotated,
                                     Class<A> annotationType)
```
    Get program element annotation of a certain annotation type. The difference with Annotated.getAnnotation(Class) is that this method will recursively search inside all Stereotype annotations.
    
    Type Parameters:
    A - The generic annotation type.
    Parameters:
    annotated - A Java program element that can be annotated.
    annotationType - The class of the annotation type.
    
    Returns:
    The program element annotation of the given annotation type if it could be found, otherwise null.
    Since:
    
    1.8

Class Beans

Usage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Beans

Method Detail

getManager

resolve

getReference

getReference

getInstance

getInstance

getInstance

getActiveInstances

destroy

destroy

getAnnotation