Package org.hibernate.search.engine.search.sort.dsl

Interface CompositeSortComponentsStep<S extends CompositeSortComponentsStep<?>>

Type Parameters:
S - The "self" type (the actual exposed type of this step).
All Superinterfaces:
SortFinalStep, SortThenStep
public interface CompositeSortComponentsStep<S extends CompositeSortComponentsStep<?>> extends SortFinalStep, SortThenStep
The initial and final step in a composite sort definition, where sort elements can be added.

This is only used in "explicit" composite sorts, for example when calling SearchSortFactory.composite(), but not in "implicit" composite sorts such as when calling SortThenStep.then().

  • Method Summary

    Modifier and Type
    Method
    Description
    default S
    add(SortFinalStep dslFinalStep)
    Add an element to the composite sort based on an almost-built SearchSort.
    S
    add(SearchSort searchSort)
    Add an element to the composite sort based on a previously-built SearchSort.

    Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SortFinalStep

    toSort

    Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SortThenStep

    then

  • Method Details

    • add

      S add(SearchSort searchSort)
      Add an element to the composite sort based on a previously-built SearchSort.
      Parameters:
      searchSort - The sort to add.
      Returns:
      this, for method chaining.

    • add

      default S add(SortFinalStep dslFinalStep)
      Add an element to the composite sort based on an almost-built SearchSort.
      Parameters:
      dslFinalStep - A final step in the sort DSL allowing the retrieval of a SearchSort.
      Returns:
      this, for method chaining.