Skip to content

Commit 81c501d

Browse files
committed
DATAMONGO-784 - Polishing.
Add JavaDoc for compareValue. Original pull request: spring-projects#414.
1 parent b1cd7cf commit 81c501d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ProjectionOperation.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,7 @@ public ProjectionOperationBuilder size() {
617617
/**
618618
* Generates a {@code $cmp} expression (compare to) that compares the value of the field to a given value or field.
619619
*
620+
* @param compareValue compare value or a {@link Field} object.
620621
* @return never {@literal null}.
621622
* @since 1.10
622623
*/
@@ -627,6 +628,7 @@ public ProjectionOperationBuilder cmp(Object compareValue) {
627628
/**
628629
* Generates a {@code $eq} expression (equal) that compares the value of the field to a given value or field.
629630
*
631+
* @param compareValue compare value or a {@link Field} object.
630632
* @return never {@literal null}.
631633
* @since 1.10
632634
*/
@@ -637,6 +639,7 @@ public ProjectionOperationBuilder eq(Object compareValue) {
637639
/**
638640
* Generates a {@code $gt} expression (greater than) that compares the value of the field to a given value or field.
639641
*
642+
* @param compareValue compare value or a {@link Field} object.
640643
* @return never {@literal null}.
641644
* @since 1.10
642645
*/
@@ -648,6 +651,7 @@ public ProjectionOperationBuilder gt(Object compareValue) {
648651
* Generates a {@code $gte} expression (greater than equal) that compares the value of the field to a given value or
649652
* field.
650653
*
654+
* @param compareValue compare value or a {@link Field} object.
651655
* @return never {@literal null}.
652656
* @since 1.10
653657
*/
@@ -658,6 +662,7 @@ public ProjectionOperationBuilder gte(Object compareValue) {
658662
/**
659663
* Generates a {@code $lt} expression (less than) that compares the value of the field to a given value or field.
660664
*
665+
* @param compareValue compare value or a {@link Field} object.
661666
* @return never {@literal null}.
662667
* @since 1.10
663668
*/
@@ -669,6 +674,7 @@ public ProjectionOperationBuilder lt(Object compareValue) {
669674
* Generates a {@code $lte} expression (less than equal) that compares the value of the field to a given value or
670675
* field.
671676
*
677+
* @param compareValue the compare value or a {@link Field} object.
672678
* @return never {@literal null}.
673679
* @since 1.10
674680
*/
@@ -679,6 +685,7 @@ public ProjectionOperationBuilder lte(Object compareValue) {
679685
/**
680686
* Generates a {@code $ne} expression (not equal) that compares the value of the field to a given value or field.
681687
*
688+
* @param compareValue compare value or a {@link Field} object.
682689
* @return never {@literal null}.
683690
* @since 1.10
684691
*/

0 commit comments

Comments
 (0)