Skip to content

Commit c82dd33

Browse files
committed
update javadoc to reflect reality that Boolean and Number versions of value() queries will only match JSON, not XML nor fields
1 parent bbf46f8 commit c82dd33

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/main/java/com/marklogic/client/query/StructuredQueryBuilder.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -401,9 +401,9 @@ public StructuredQueryDefinition value(TextIndex index, String... values) {
401401
return new ValueQuery(index, null, null, null, values);
402402
}
403403
/**
404-
* Matches an element, attribute, json key, or field
405-
* that has a value with the same boolean value as at least one
406-
* of the criteria values.
404+
* Matches a json key that has a value with the same boolean value
405+
* as at least one of the criteria values. Note this method will not match
406+
* any XML node.
407407
* @param index the value container
408408
* @param value either true or false
409409
* @return the StructuredQueryDefinition for the value query
@@ -412,9 +412,9 @@ public StructuredQueryDefinition value(TextIndex index, Boolean value) {
412412
return new ValueQuery(index, null, null, null, new Object[] {value});
413413
}
414414
/**
415-
* Matches an element, attribute, json key, or field
416-
* that has a value with the same numeric value as at least one
417-
* of the criteria values.
415+
* Matches an json key that has a value with the same numeric
416+
* value as at least one of the criteria values. Note this method will not
417+
* match any XML node.
418418
* @param index the value container
419419
* @param values the possible values to match
420420
* @return the StructuredQueryDefinition for the value query
@@ -437,9 +437,9 @@ public StructuredQueryDefinition value(TextIndex index, FragmentScope scope, Str
437437
return new ValueQuery(index, scope, options, weight, values);
438438
}
439439
/**
440-
* Matches an element, attribute, json key, or field
441-
* that has a value with the same boolean value as at least one
442-
* of the criteria values.
440+
* Matches an json key that has a value with the same boolean
441+
* value as at least one of the criteria values. Note this method will not
442+
* match any XML node.
443443
* @param index the value container
444444
* @param scope whether the query matches the document content or properties
445445
* @param options options for fine tuning the query
@@ -451,9 +451,9 @@ public StructuredQueryDefinition value(TextIndex index, FragmentScope scope, Str
451451
return new ValueQuery(index, scope, options, weight, new Object[] {value});
452452
}
453453
/**
454-
* Matches an element, attribute, json key, or field
455-
* that has a value with the same numeric value as at least one
456-
* of the criteria values.
454+
* Matches an json key that has a value with the same numeric
455+
* value as at least one of the criteria values. Note this method will not
456+
* match any XML node.
457457
* @param index the value container
458458
* @param scope whether the query matches the document content or properties
459459
* @param options options for fine tuning the query

0 commit comments

Comments
 (0)