update javadocs for new wildcard methods

Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
opensearch-project · Dec 8, 2022 · 8cea795 · 8cea795
1 parent 378310b
commit 8cea795
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java b/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java
@@ -290,6 +290,7 @@ public final Query wildcardQuery(String value, @Nullable MultiTermQuery.RewriteM
         return wildcardQuery(value, method, false, context);
     }
 
+    /** optionally normalize the wildcard pattern based on the value of {@code caseInsensitive} */
     public Query wildcardQuery(
         String value,
         @Nullable MultiTermQuery.RewriteMethod method,
@@ -302,6 +303,7 @@ public Query wildcardQuery(
         );
     }
 
+    /** always normalizes the wildcard pattern to lowercase */
     public Query normalizedWildcardQuery(String value, @Nullable MultiTermQuery.RewriteMethod method, QueryShardContext context) {
         throw new QueryShardException(
             context,

diff --git a/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java b/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java
@@ -152,11 +152,13 @@ public static final String normalizeWildcardPattern(String fieldname, String val
         return sb.toBytesRef().utf8ToString();
     }
 
+    /** optionally normalize the wildcard pattern based on the value of {@code caseInsensitive} */
     @Override
     public Query wildcardQuery(String value, MultiTermQuery.RewriteMethod method, boolean caseInsensitive, QueryShardContext context) {
         return wildcardQuery(value, method, caseInsensitive, false, context);
     }
 
+    /** always normalizes the wildcard pattern to lowercase */
     @Override
     public Query normalizedWildcardQuery(String value, MultiTermQuery.RewriteMethod method, QueryShardContext context) {
         return wildcardQuery(value, method, false, true, context);