org.hibernate.search.analyzer.spi.AnalyzerReference Maven / Gradle / Ivy

Go to download
/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.analyzer.spi;

/**
 * Reference to an analyzer implementation.
 *
 * @author Davide D'Alto
 * @hsearch.experimental This type is under active development as part of the Elasticsearch integration. You should be
 * prepared for incompatible changes in future releases.
 */
public interface AnalyzerReference {

	/**
	 * @return The referenced analyzer.
	 */
	Object getAnalyzer();

	/**
	 * Check if the analyzer can be represented using a specific class.
	 *
	 * @param analyzerType an {@link AnalyzerReference} type
	 * @return true if this implementation can be represented as an instance of T
	 */
	 boolean is(Class analyzerType);

	/**
	 * Convert this instance to T
	 *
	 * @param  an {@link AnalyzerReference} type
	 * @param analyzerType the class T
	 * @return this instance as T
	 */
	 T unwrap(Class analyzerType);

	/**
	 * Close analyzer if possible
	 */
	void close();
}