org.hibernate.search.engine.backend.scope.IndexScopeExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation

Hibernate Search engine, always required

There is a newer version: 8.0.0.Alpha1

Show newest version

/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.engine.backend.scope;

import org.hibernate.search.engine.backend.scope.spi.IndexScope;

/**
 * An extension to the index scope, providing an extended index scope offering backend-specific utilities.
 * 
 * WARNING: while this type is API, because instances should be manipulated by users,
 * all of its methods are considered SPIs and therefore should never be called or implemented directly by users.
 * In short, users are only expected to get instances of this type from an API ({@code SomeExtension.get()})
 * and pass it to another API.
 *
 * @param  The type of extended index scope.
 * Should generally extend {@link IndexScope}.
 *
 * @see IndexScope#extension(IndexScopeExtension)
 */
public interface IndexScopeExtension {

	/**
	 * Attempt to extend an index scope, throwing an exception in case of failure.
	 * 
	 * WARNING: this method is not API, see comments at the type level.
	 *
	 * @param original The original, non-extended {@link IndexScope}.
	 * @return An extended index scope ({@link T})
	 */
	T extendOrFail(IndexScope original);

}