Package org.hibernate.search.mapper.orm.mapping

Interface SearchMappingExtension<T>

Type Parameters:
T - The type of extended search mapping. Should generally extend SearchMapping.
All Known Implementing Classes:
OutboxPollingExtension
public interface SearchMappingExtension<T>
An extension to the search mapping, providing an extended search mapping offering mapper-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(SearchMapping original)
    Attempt to extend a search mapping, throwing an exception in case of failure.

  • Method Details

    • extendOrFail

      T extendOrFail(SearchMapping original)
      Attempt to extend a search mapping, 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 SearchMapping.
      Returns:
      An extended search mapping (SearchMappingExtension)