com.haulmont.cuba.core.global

Interface BeanLocator

All Known Implementing Classes:

BeanLocatorImpl

public interface BeanLocator

Provides access to all managed beans of the application block.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
boolean	containsBean(java.lang.String name) Whether a bean with the given name is present.
<T> T	get(java.lang.Class<T> beanType) Returns the bean instance that matches the given object type.
<T> T	get(java.lang.String name) Return an instance of the specified bean.
<T> T	get(java.lang.String name, java.lang.Class<T> beanType) Returns an instance of the specified bean.
<T> java.util.Map<java.lang.String,T>	getAll(java.lang.Class<T> beanType) Returns the bean instances that match the given object type (including subclasses).
<T> T	getPrototype(java.lang.String name, java.lang.Object... args) Returns an instance of prototype bean, specifying explicit constructor arguments.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

get

<T> T get(java.lang.Class<T> beanType)

Returns the bean instance that matches the given object type. If the provided bean class contains a public static field NAME, this name is used to look up the bean to improve performance.

Parameters:

beanType - type the bean must match; can be an interface or superclass. null is disallowed.

Returns:

an instance of the single bean matching the required type

get

<T> T get(java.lang.String name)

Return an instance of the specified bean.

Parameters:

name - the name of the bean to retrieve

Returns:

bean instance

See Also:

BeanFactory.getBean(java.lang.String)

get

<T> T get(java.lang.String name,
          @Nullable
          java.lang.Class<T> beanType)

Returns an instance of the specified bean.

Parameters:

name - the name of the bean to retrieve

beanType - type the bean must match. Can be an interface or superclass of the actual class, or null for any match. For example, if the value is Object.class, this method will succeed whatever the class of the returned instance.

Returns:

bean instance

getPrototype

<T> T getPrototype(java.lang.String name,
                   java.lang.Object... args)

Returns an instance of prototype bean, specifying explicit constructor arguments.

Parameters:

name - the name of the bean to retrieve

args - constructor arguments

Returns:

bean instance

getAll

<T> java.util.Map<java.lang.String,T> getAll(java.lang.Class<T> beanType)

Returns the bean instances that match the given object type (including subclasses).

The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.

Parameters:

beanType - the class or interface to match, or null for all concrete beans

Returns:

a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values

containsBean

boolean containsBean(java.lang.String name)

Whether a bean with the given name is present.