Package org.hibernate.search.engine.backend

Interface Backend

All Known Subinterfaces:
ElasticsearchBackend, LuceneBackend
public interface Backend
A backend as viewed by Hibernate Search users.

This interface exposes all operations that Hibernate Search users should be able to execute directly on the backend, without having to go through mapper-specific APIs.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    name()
     
    <T> T
    unwrap(Class<T> clazz)
    Unwrap the backend to some implementation-specific type.

  • Method Details

    • unwrap

      <T> T unwrap(Class<T> clazz)
      Unwrap the backend to some implementation-specific type.
      Type Parameters:
      T - The expected type
      Parameters:
      clazz - The Class representing the expected type
      Returns:
      The unwrapped backend.
      Throws:
      SearchException - if the backend implementation does not support unwrapping to the given class.

    • name

      @Incubating Optional<String> name()
      Returns:
      The name of the backend. In case of a default backend - an empty optional.