org.hibernate.search.engine.cfg.package-info Maven / Gradle / Ivy

Go to download
/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */

/**
 * This package contains everything related to the configuration of the Hibernate Search engine.
 *
 * Common expected types for property values
 *
 * Below are some commonly used property types across all Hibernate Search settings
 * (engine, backends, mappers, ...).
 *
 * Bean reference
 *
 * A reference to a bean of type {@code T} can be passed as either:
 * 
 * An instance of {@code T},
 * 
or a {@link org.hibernate.search.engine.environment.bean.BeanReference BeanReference}
 * to a bean in the dependency injection context (CDI/Spring/etc.),
 * 
or a {@link java.lang.Class Class} representing the type of such a bean,
 * 
or a {@link java.lang.String String} representing the name of such a bean,
 * 
or a {@link org.hibernate.search.engine.environment.bean.BeanReference BeanReference}
 * to a type exposing a public, no-arg constructor,
 * to be instantiated through that constructor outside of any injection context,
 * 
or a {@link java.lang.Class Class} representing such type,
 * 
or a {@link java.lang.String String} representing the fully-qualified name of such type.
 * 
 * The value will be interpreted in the above order.
 * For example if CDI is used in the application, and a bean-reference property is set to a {@link java.lang.Class Class}
 * representing the type of a CDI bean which happens to expose a public, no-arg constructor,
 * then Hibernate Search will retrieve the bean through CDI, not by calling the constructor directly.
 *
 * Multi-valued bean reference
 *
 * A multivalued reference to a bean of type {@code T} can be passed as either:
 * 
 * A {@link java.util.Collection Collection} containing any
 * value that is accepted as a bean reference
 * or a comma-separated {@link java.lang.String String} containing any
 * String value that is accepted as a bean reference
 * or any value accepted for a single-valued bean reference
 * 
 */
package org.hibernate.search.engine.cfg;