Beans

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

```
public final class Beans
extends Object
```
Collection of utility methods for the CDI API with respect to working with BeanManager.
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 instead.

Since:

1.6.1

Author:

Bauke Scholtz

Constructor Summary

Constructors
Constructor and Description

Beans()

Constructors
Constructor and Description
`Beans()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Map<Object,String>`	`getActiveInstances(BeanManager beanManager, Class<? extends Annotation> scope)` Returns all active CDI managed bean instances in the given CDI managed bean scope.
`static <T extends Annotation> T`	`getAnnotation(BeanManager beanManager, Annotated annotated, Class<T> annotationType)` Get program element annotation of a certain annotation type.
`static <T extends Annotation> T`	`getAnnotation(BeanManager beanManager, Collection<Annotation> initialAnnotations, Class<T> annotationType)` Get program element annotation of a certain annotation type from a collection of annotations.
`static <T> T`	`getInstance(BeanManager beanManager, 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(BeanManager beanManager, Class<T> beanClass)` Returns the CDI managed bean instance of the given class from the given bean manager and creates one if one doesn't exist.
`static <T> T`	`getInstance(BeanManager beanManager, Class<T> beanClass, boolean create)` Returns the CDI managed bean instance of the given class 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`	`getReference(BeanManager beanManager, Bean<T> bean)` Returns the CDI managed bean reference of the given resolved bean from the given bean manager.
`static <T> T`	`getReference(BeanManager beanManager, Class<T> beanClass)` Returns the CDI managed bean reference of the given class from the given bean manager.
`static <T> Bean<T>`	`resolve(BeanManager beanManager, Class<T> beanClass)` Resolve and returns the CDI managed bean of the given class from the given bean manager.

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
  - resolve
```
public static <T> Bean<T> resolve(BeanManager beanManager,
                  Class<T> beanClass)
```
    Resolve and returns the CDI managed bean of the given class from the given bean manager.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    beanClass - The type of the CDI managed bean instance.
    
    Returns:
    The resolved CDI managed bean of the given class from the given bean manager.
  - getReference
```
public static <T> T getReference(BeanManager beanManager,
                 Class<T> beanClass)
```
    Returns the CDI managed bean reference of the given class from the given bean manager. Note that this actually returns a client proxy and the underlying instance is thus always auto-created.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    beanClass - The type of the CDI managed bean instance.
    
    Returns:
    The CDI managed bean reference of the given class from the given bean manager.
  - getReference
```
public static <T> T getReference(BeanManager beanManager,
                 Bean<T> bean)
```
    Returns the CDI managed bean reference of the given resolved bean from the given bean manager. Note that this actually returns a client proxy and the underlying instance is thus always auto-created.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    bean - The resolved bean of the CDI managed bean instance.
    
    Returns:
    The CDI managed bean reference of the given resolved bean from the given bean manager.
  - getInstance
```
public static <T> T getInstance(BeanManager beanManager,
                Class<T> beanClass)
```
    Returns the CDI managed bean instance of the given class from the given bean manager and creates one if one doesn't exist.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    beanClass - The type of the CDI managed bean instance.
    
    Returns:
    The CDI managed bean instance of the given class from the given bean manager.
    Since:
    
    1.8
  - getInstance
```
public static <T> T getInstance(BeanManager beanManager,
                Class<T> beanClass,
                boolean create)
```
    Returns the CDI managed bean instance of the given class 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.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    beanClass - The type of the CDI managed bean instance.
    create - If true, then create one if one doesn't exist, otherwise don't create one and return null if there's no current instance.
    
    Returns:
    The CDI managed bean instance of the given class from the given bean manager.
    Since:
    
    1.7
  - getInstance
```
public static <T> T getInstance(BeanManager beanManager,
                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.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    bean - The resolved bean of the CDI managed bean instance.
    create - If true, then create one if one doesn't exist, otherwise don't create one and return null if there's no current instance.
    
    Returns:
    The CDI managed bean instance of the given class from the given bean manager.
    Since:
    
    1.7
  - getActiveInstances
```
public static Map<Object,String> getActiveInstances(BeanManager beanManager,
                                    Class<? extends Annotation> 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.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    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
  - getAnnotation
```
public static <T extends Annotation> T getAnnotation(BeanManager beanManager,
                                     Annotated annotated,
                                     Class<T> 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.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    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
  - getAnnotation
```
public static <T extends Annotation> T getAnnotation(BeanManager beanManager,
                                     Collection<Annotation> initialAnnotations,
                                     Class<T> annotationType)
```
    Get program element annotation of a certain annotation type from a collection of annotations.
    This method will investigate the list of the initial annotations and for every such annotation that's a stereo type will recursively investigate the annotations represented by the stereo type as long as the given annotation type hasn't been encountered.
    
    Parameters:
    beanManager - The involved CDI bean manager.
    initialAnnotations - collection of annotations to investigate
    annotationType - the class of the annotation type
    
    Returns:
    the annotation of the given annotation type if it could be found, otherwise null
    Since:
    
    1.8

Class Beans

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Beans

Method Detail

resolve

getReference

getReference

getInstance

getInstance

getInstance

getActiveInstances

getAnnotation

getAnnotation