Package org.hibernate.search.engine.common.schema.management

Interface SchemaExportExtension<T>

  • Type Parameters:
    T - The type of extended index schema export. Should generally extend SchemaExport.
    All Known Implementing Classes:
    ElasticsearchExtension, LuceneExtension
    @Incubating
public interface SchemaExportExtension<T>
    An extension to the index schema export, allowing to access backend-specific methods of a schema export.

    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:
    SchemaExport.extension(SchemaExportExtension)

    • Method Detail

      • extendOrFail

        T extendOrFail​(SchemaExport original)
        Attempt to extend a given export, 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 SchemaExport.
        Returns:
        An extended index schema export.