Package org.hibernate.search.engine.backend.scope

Interface IndexScopeExtension<T>

Type Parameters:
T - The type of extended index scope. Should generally extend IndexScope.
All Known Implementing Classes:
LuceneExtension
public interface IndexScopeExtension<T>
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 (SomeExtension.get()) and pass it to another API.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    extendOrFail(IndexScope original)
    Attempt to extend an index scope, throwing an exception in case of failure.

  • Method Details

    • extendOrFail

      T extendOrFail(IndexScope original)
      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.

      Parameters:
      original - The original, non-extended IndexScope.
      Returns:
      An extended index scope (IndexScopeExtension)