HSEARCH-5300 Add even more @Incubating to various field references

marko-bekhta · marko-bekhta · commit 34332473a786 · 2025-05-05T21:39:00.000+02:00
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/AggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/AggregationFieldReference.java
@@ -5,6 +5,8 @@
 package org.hibernate.search.engine.search.reference.aggregation;
 
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface AggregationFieldReference<SR> extends FieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/AvgAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/AvgAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface AvgAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/CountAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/CountAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface CountAggregationFieldReference<SR> extends AggregationFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/CountDistinctAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/CountDistinctAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface CountDistinctAggregationFieldReference<SR> extends AggregationFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/MaxAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/MaxAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface MaxAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/MinAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/MinAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface MinAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/RangeAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/RangeAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface RangeAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/SumAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/SumAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface SumAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/TermsAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/TermsAggregationFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.aggregation;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface TermsAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/TypedAggregationFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/TypedAggregationFieldReference.java
@@ -5,7 +5,9 @@
 package org.hibernate.search.engine.search.reference.aggregation;
 
 import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface TypedAggregationFieldReference<SR, T> extends AggregationFieldReference<SR> {
 
 	Class<T> aggregationType();
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/object/FlattenedFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/object/FlattenedFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.object;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface FlattenedFieldReference<SR> extends ObjectFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/object/NestedFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/object/NestedFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.object;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface NestedFieldReference<SR> extends ObjectFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/object/ObjectFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/object/ObjectFieldReference.java
@@ -5,6 +5,8 @@
 package org.hibernate.search.engine.search.reference.object;
 
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface ObjectFieldReference<SR> extends FieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/ExistsPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/ExistsPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface ExistsPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/KnnPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/KnnPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface KnnPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/MatchPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/MatchPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface MatchPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/NestedPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/NestedPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface NestedPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PhrasePredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PhrasePredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface PhrasePredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PredicateFieldReference.java
@@ -5,7 +5,8 @@
 package org.hibernate.search.engine.search.reference.predicate;
 
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
-
+@Incubating
 public interface PredicateFieldReference<SR> extends FieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PrefixPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/PrefixPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface PrefixPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/QueryStringPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/QueryStringPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface QueryStringPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/RangePredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/RangePredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface RangePredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/RegexpPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/RegexpPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface RegexpPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/SimpleQueryStringPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/SimpleQueryStringPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface SimpleQueryStringPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/SpatialPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/SpatialPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface SpatialPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/TermsPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/TermsPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface TermsPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/TypedPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/TypedPredicateFieldReference.java
@@ -6,7 +6,9 @@
 
 import org.hibernate.search.engine.search.common.ValueModel;
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface TypedPredicateFieldReference<SR, T> extends FieldReference<SR> {
 
 	Class<T> predicateType();
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/WildcardPredicateFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/WildcardPredicateFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.predicate;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface WildcardPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/DistanceProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/DistanceProjectionFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.projection;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface DistanceProjectionFieldReference<SR> extends ProjectionFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/FieldProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/FieldProjectionFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.projection;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface FieldProjectionFieldReference<SR, T> extends TypedProjectionFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/HighlightProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/HighlightProjectionFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.projection;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface HighlightProjectionFieldReference<SR> extends ProjectionFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/ObjectProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/ObjectProjectionFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.projection;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface ObjectProjectionFieldReference<SR> extends ProjectionFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/ProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/ProjectionFieldReference.java
@@ -5,6 +5,8 @@
 package org.hibernate.search.engine.search.reference.projection;
 
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface ProjectionFieldReference<SR> extends FieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/TypedProjectionFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/projection/TypedProjectionFieldReference.java
@@ -5,7 +5,9 @@
 package org.hibernate.search.engine.search.reference.projection;
 
 import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface TypedProjectionFieldReference<SR, T> extends ProjectionFieldReference<SR> {
 
 	Class<T> projectionType();
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/DistanceSortFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/DistanceSortFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.sort;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface DistanceSortFieldReference<SR> extends SortFieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/FieldSortFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/FieldSortFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.sort;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface FieldSortFieldReference<SR, T> extends TypedSortFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/ScoreSortFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/ScoreSortFieldReference.java
@@ -4,5 +4,8 @@
  */
 package org.hibernate.search.engine.search.reference.sort;
 
+import org.hibernate.search.util.common.annotation.Incubating;
+
+@Incubating
 public interface ScoreSortFieldReference<SR, T> extends TypedSortFieldReference<SR, T> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/SortFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/SortFieldReference.java
@@ -5,6 +5,8 @@
 package org.hibernate.search.engine.search.reference.sort;
 
 import org.hibernate.search.engine.search.reference.FieldReference;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface SortFieldReference<SR> extends FieldReference<SR> {
 }
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/TypedSortFieldReference.java b/engine/src/main/java/org/hibernate/search/engine/search/reference/sort/TypedSortFieldReference.java
@@ -5,7 +5,9 @@
 package org.hibernate.search.engine.search.reference.sort;
 
 import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
 
+@Incubating
 public interface TypedSortFieldReference<SR, T> extends SortFieldReference<SR> {
 
 	Class<T> sortType();

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`package org.hibernate.search.engine.search.reference.aggregation;`
`6`	`6`
`7`	`7`	`import org.hibernate.search.engine.search.reference.FieldReference;`
	`8`	`+import org.hibernate.search.util.common.annotation.Incubating;`
`8`	`9`
	`10`	`+@Incubating`
`9`	`11`	`public interface AggregationFieldReference<SR> extends FieldReference<SR> {`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,8 @@`
`4`	`4`	`*/`
`5`	`5`	`package org.hibernate.search.engine.search.reference.aggregation;`
`6`	`6`
	`7`	`+import org.hibernate.search.util.common.annotation.Incubating;`
	`8`	`+`
	`9`	`+@Incubating`
`7`	`10`	`public interface AvgAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {`
`8`	`11`	`}`