org.hibernate.search.engine.environment.bean.spi

Interface BeanProvider

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ReflectionBeanProvider

public interface BeanProvider
extends AutoCloseable

The interface to be implemented by components providing beans to Hibernate Search.

This interface should only be called by Hibernate Search itself; if you are looking to retrieve beans, you should use BeanResolver instead.

Method Summary

Modifier and Type	Method and Description
void	close() Release any internal resource created to support provided beans.
<T> BeanHolder<T>	getBean(Class<T> typeReference) Provide a bean referenced by its type.
<T> BeanHolder<T>	getBean(Class<T> typeReference, String nameReference) Provide a bean referenced by its type and name.

Method Detail

close

void close()

Release any internal resource created to support provided beans.

Provided beans will not be usable after a call to this method.

This may not release all resources that were allocated for each BeanHolder; BeanHolder.close() still needs to be called consistently for each created bean.

Specified by:

close in interface AutoCloseable

See Also:

AutoCloseable.close()

getBean

<T> BeanHolder<T> getBean(Class<T> typeReference)

Provide a bean referenced by its type.

Type Parameters:

T - The expected return type.

Parameters:

typeReference - The type used as a reference to the bean to retrieve. Must be non-null.

Returns:

A BeanHolder containing the resolved bean.

Throws:

SearchException - if the reference is invalid (null) or the bean does not exist.

getBean

<T> BeanHolder<T> getBean(Class<T> typeReference,
                          String nameReference)

Provide a bean referenced by its type and name.

Type Parameters:

T - The expected return type.

Parameters:

typeReference - The type used as a reference to the bean to retrieve. Must be non-null.

nameReference - The name used as a reference to the bean to retrieve. Must be non-null and non-empty.

Returns:

A BeanHolder containing the resolved bean.

Throws:

SearchException - if a reference is invalid (null or empty) or the bean does not exist.