Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Enum Classes
• Fields
• Methods
• Enum Constants

Terminally Deprecated Elements

Element	Description
org.hibernate.search.engine.backend.types.IndexFieldTraits.Aggregations.COUNT_DISTINCT	Use IndexFieldTraits.Aggregations.COUNT instead.
org.hibernate.search.engine.search.aggregation.dsl.ExtendedSearchAggregationFactory.countDistinct()
org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory.countDistinct()	Use SearchAggregationFactory.count() with CountValuesAggregationOptionsStep.distinct() instead.
org.hibernate.search.engine.search.aggregation.dsl.spi.AbstractSearchAggregationFactory.countDistinct()
org.hibernate.search.engine.search.aggregation.dsl.TypedSearchAggregationFactory.countDistinct()	Use TypedSearchAggregationFactory.count() with CountValuesAggregationOptionsStep.distinct() instead.
org.hibernate.search.engine.search.common.ValueModel.DEFAULT	This constant is deprecated and will be removed at the same time as the ValueConvert enum is removed. Do not use this value explicitly.
org.hibernate.search.engine.search.projection.definition.ProjectionDefinition.create(SearchProjectionFactory<?, ?>, ProjectionDefinitionContext)	Use ProjectionDefinition.create(ProjectionDefinitionContext) and ProjectionDefinitionContext.projection() instead.
org.hibernate.search.engine.search.projection.definition.spi.CompositeProjectionDefinition.create(SearchProjectionFactory<?, ?>, ProjectionDefinitionContext)
org.hibernate.search.engine.search.projection.spi.ProjectionCompositor	Use ResultsCompositor instead.

Deprecated Interfaces

Interface	Description
org.hibernate.search.engine.backend.types.converter.FromDocumentFieldValueConverter	Implement FromDocumentValueConverter instead.
org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContext	Use FromDocumentValueConverter with FromDocumentValueConvertContext instead.
org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContextExtension	Use FromDocumentValueConverter with FromDocumentValueConvertContext and FromDocumentValueConvertContextExtension instead.
org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContext	Use ToDocumentValueConverter with ToDocumentValueConvertContext instead.
org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContextExtension	Use ToDocumentValueConverter with ToDocumentValueConvertContext and ToDocumentValueConvertContextExtension instead.
org.hibernate.search.engine.backend.types.converter.ToDocumentFieldValueConverter	Implement ToDocumentValueConverter instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateFieldStep	Use TypedSearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateNestStep	Use TypedSearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateOptionsStep	Use TypedSearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.projection.spi.ProjectionAccumulator	Use ProjectionCollector instead.
org.hibernate.search.engine.search.projection.spi.ProjectionCompositor	Use ResultsCompositor instead.

Deprecated Classes

Class	Description
org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition.MultiValued
org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition.SingleValued
org.hibernate.search.engine.search.projection.definition.spi.FieldProjectionDefinition.MultiValued
org.hibernate.search.engine.search.projection.definition.spi.FieldProjectionDefinition.SingleValued
org.hibernate.search.engine.search.projection.definition.spi.ObjectProjectionDefinition.MultiValued
org.hibernate.search.engine.search.projection.definition.spi.ObjectProjectionDefinition.SingleValued

Deprecated Enum Classes

Enum Class	Description
org.hibernate.search.engine.search.common.ValueConvert	Use ValueModel instead.

Deprecated Fields

Field	Description
org.hibernate.search.engine.backend.types.IndexFieldTraits.Aggregations.COUNT_DISTINCT	Use IndexFieldTraits.Aggregations.COUNT instead.

Deprecated Methods

Method	Description
org.hibernate.search.engine.backend.orchestration.spi.BatchingExecutor.submit(W)	Use BatchingExecutor.submit(BatchedWork, OperationSubmitter) instead.
org.hibernate.search.engine.backend.types.converter.runtime.spi.FromDocumentValueConvertContextImpl.extension(FromDocumentFieldValueConvertContextExtension<T>)
org.hibernate.search.engine.backend.types.converter.runtime.spi.ToDocumentValueConvertContextImpl.extension(ToDocumentFieldValueConvertContextExtension<T>)
org.hibernate.search.engine.cfg.spi.KeyContext.asInteger()	Use KeyContext.asIntegerPositiveOrZeroOrNegative() instead.
org.hibernate.search.engine.cfg.spi.KeyContext.asLong()	Use KeyContext.asLongPositiveOrZeroOrNegative() instead.
org.hibernate.search.engine.reporting.EntityIndexingFailureContext.Builder.entityReference(Object)	Use EntityIndexingFailureContext.Builder.failingEntityReference(EntityReference) instead.
org.hibernate.search.engine.reporting.EntityIndexingFailureContext.entityReferences()	Use EntityIndexingFailureContext.failingEntityReferences() instead.
org.hibernate.search.engine.search.aggregation.dsl.ExtendedSearchAggregationFactory.countDistinct()
org.hibernate.search.engine.search.aggregation.dsl.RangeAggregationFieldStep.field(String, Class<F>, ValueConvert)	Use RangeAggregationFieldStep.field(String, Class, ValueModel) instead.
org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory.countDistinct()	Use SearchAggregationFactory.count() with CountValuesAggregationOptionsStep.distinct() instead.
org.hibernate.search.engine.search.aggregation.dsl.spi.AbstractSearchAggregationFactory.countDistinct()
org.hibernate.search.engine.search.aggregation.dsl.TermsAggregationFieldStep.field(String, Class<F>, ValueConvert)	Use TermsAggregationFieldStep.field(String, Class, ValueModel) instead.
org.hibernate.search.engine.search.aggregation.dsl.TypedSearchAggregationFactory.countDistinct()	Use TypedSearchAggregationFactory.count() with CountValuesAggregationOptionsStep.distinct() instead.
org.hibernate.search.engine.search.common.ValueConvert.toValueModel(ValueConvert)
org.hibernate.search.engine.search.predicate.definition.PredicateDefinitionContext.param(String)	Use PredicateDefinitionContext.params() instead.
org.hibernate.search.engine.search.predicate.definition.PredicateDefinitionContext.param(String, Class<T>)	Use PredicateDefinitionContext.params() instead.
org.hibernate.search.engine.search.predicate.definition.PredicateDefinitionContext.paramOptional(String)	Use PredicateDefinitionContext.params() instead.
org.hibernate.search.engine.search.predicate.definition.PredicateDefinitionContext.paramOptional(String, Class<T>)	Use PredicateDefinitionContext.params() instead.
org.hibernate.search.engine.search.predicate.dsl.MatchIdPredicateMatchingStep.matching(Object, ValueConvert)	Use MatchIdPredicateMatchingStep.matching(Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.MatchIdPredicateMatchingStep.matchingAny(Collection<?>, ValueConvert)	Use MatchIdPredicateMatchingStep.matchingAny(Collection, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.MatchPredicateMatchingStep.matching(Object, ValueConvert)	Use MatchPredicateMatchingStep.matching(Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.atLeast(Object, ValueConvert)	Use RangePredicateMatchingStep.atLeast(Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.atMost(Object, ValueConvert)	Use RangePredicateMatchingStep.atMost(Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.between(Object, Object, ValueConvert)	Use RangePredicateMatchingStep.between(Object, Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.greaterThan(Object, ValueConvert)	Use RangePredicateMatchingStep.greaterThan(Object, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.lessThan(Object, ValueConvert)
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.range(Range<?>)	Use RangePredicateMatchingStep.within(Range) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.range(Range<?>, ValueConvert)	Use RangePredicateMatchingStep.within(Range, org.hibernate.search.engine.search.common.ValueConvert) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.within(Range<?>, ValueConvert)	Use RangePredicateMatchingStep.within(Range, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.RangePredicateMatchingStep.withinAny(Collection<? extends Range<?>>, ValueConvert)	Use RangePredicateMatchingStep.withinAny(Collection, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory.bool(Consumer<? super BooleanPredicateClausesStep<?, ?>>)	Use .bool().with(...) instead.
org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory.nested()	Use SearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.spi.AbstractSearchPredicateFactory.nested()
org.hibernate.search.engine.search.predicate.dsl.TermsPredicateMatchingStep.matchingAll(Collection<?>, ValueConvert)	Use TermsPredicateMatchingStep.matchingAll(Collection, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.TermsPredicateMatchingStep.matchingAny(Collection<?>, ValueConvert)	Use TermsPredicateMatchingStep.matchingAny(Collection, ValueModel) instead.
org.hibernate.search.engine.search.predicate.dsl.TypedSearchPredicateFactory.nested()	Use TypedSearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.projection.definition.ProjectionDefinition.create(SearchProjectionFactory<?, ?>, ProjectionDefinitionContext)	Use ProjectionDefinition.create(ProjectionDefinitionContext) and ProjectionDefinitionContext.projection() instead.
org.hibernate.search.engine.search.projection.definition.spi.CompositeProjectionDefinition.create(SearchProjectionFactory<?, ?>, ProjectionDefinitionContext)
org.hibernate.search.engine.search.projection.definition.spi.ConstantProjectionDefinition.emptyList()	Use ConstantProjectionDefinition.empty(ProjectionCollector.Provider) instead.
org.hibernate.search.engine.search.projection.dsl.CompositeProjectionValueStep.multi()	Use CompositeProjectionValueStep.collector(ProjectionCollector.Provider) instead.
org.hibernate.search.engine.search.projection.dsl.DistanceToFieldProjectionValueStep.multi()	Use DistanceToFieldProjectionValueStep.collector(ProjectionCollector.Provider) instead.
org.hibernate.search.engine.search.projection.dsl.FieldProjectionValueStep.multi()	Use FieldProjectionValueStep.collector(ProjectionCollector.Provider) instead.
org.hibernate.search.engine.search.projection.dsl.HighlightProjectionOptionsStep.single()	Use the HighlightProjectionOptionsStep.collector(ProjectionCollector.Provider) instead, e.g. .collector(ProjectionCollector.single())
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(BiFunction<P1, P2, T>, ProjectionFinalStep<P1>, ProjectionFinalStep<P2>)	Use .composite().from( dslFinalStep1, dslFinalStep2 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(BiFunction<P1, P2, T>, SearchProjection<P1>, SearchProjection<P2>)	Use .composite().from( projection1, projection2 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<List<?>, T>, ProjectionFinalStep<?>...)	Use .composite().from( dslFinalSteps ).asList( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<List<?>, T>, SearchProjection<?>...)	Use .composite().from( projections ).asList( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<P, T>, ProjectionFinalStep<P>)	Use .composite().from( dslFinalStep ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<P, T>, SearchProjection<P>)	Use .composite().from( projection ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(TriFunction<P1, P2, P3, T>, ProjectionFinalStep<P1>, ProjectionFinalStep<P2>, ProjectionFinalStep<P3>)	Use .composite().from( dslFinalStep1, dslFinalStep2, dslFinalStep3 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(TriFunction<P1, P2, P3, T>, SearchProjection<P1>, SearchProjection<P2>, SearchProjection<P3>)	Use .composite().from( projection1, projection2, projection3 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.field(String, Class<T>, ValueConvert)	Use SearchProjectionFactory.field(String, Class, ValueModel) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.field(String, ValueConvert)	Use SearchProjectionFactory.field(String, ValueModel) instead.
org.hibernate.search.engine.search.query.spi.SearchQueryImplementor.failAfter(long, TimeUnit)
org.hibernate.search.engine.search.sort.dsl.FieldSortMissingValueBehaviorStep.use(Object, ValueConvert)	Use FieldSortMissingValueBehaviorStep.use(Object, ValueModel) instead.
org.hibernate.search.engine.Version.getVersionString()	Use Version.versionString() instead.

Deprecated Enum Constants

Enum Constant	Description
org.hibernate.search.engine.search.common.ValueConvert.DEFAULT
org.hibernate.search.engine.search.common.ValueConvert.NO	Use ValueModel.INDEX instead.
org.hibernate.search.engine.search.common.ValueConvert.YES	Use ValueModel.MAPPING instead.
org.hibernate.search.engine.search.common.ValueModel.DEFAULT	This constant is deprecated and will be removed at the same time as the ValueConvert enum is removed. Do not use this value explicitly.