fix floating javadocs, add null checks, restrict public method visiblity, add more javadocs

Signed-off-by: Karen Xu <[email protected]>

Author: karenyrx

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/common/FetchSourceContextProtoUtils.java

@@ -34,8 +34,8 @@ private FetchSourceContextProtoUtils() {
      * Converts a SourceConfig Protocol Buffer to a FetchSourceContext object.
      * Similar to {@link FetchSourceContext#parseFromRestRequest(RestRequest)}
      *
-     * @param request
-     * @return
+     * @param request The BulkRequest Protocol Buffer containing source configuration
+     * @return A FetchSourceContext object based on the request parameters, or null if no source parameters are provided
      */
     public static FetchSourceContext parseFromProtoRequest(org.opensearch.protobufs.BulkRequest request) {
         Boolean fetchSource = true;
@@ -70,9 +70,11 @@ public static FetchSourceContext parseFromProtoRequest(org.opensearch.protobufs.
     }
 
     /**
+     * Converts a SourceConfig Protocol Buffer to a FetchSourceContext object.
      * Similar to {@link FetchSourceContext#parseFromRestRequest(RestRequest)}
-     * @param request
-     * @return
+     *
+     * @param request The SearchRequest Protocol Buffer containing source configuration
+     * @return A FetchSourceContext object based on the request parameters, or null if no source parameters are provided
      */
     public static FetchSourceContext parseFromProtoRequest(org.opensearch.protobufs.SearchRequest request) {
         Boolean fetchSource = null;

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/common/ScriptProtoUtils.java

@@ -53,7 +53,7 @@ public static Script parseFromProtoRequest(org.opensearch.protobufs.Script scrip
      * @param defaultLang the default script language to use if not specified
      * @return the converted Script object
      */
-    public static Script parseFromProtoRequest(org.opensearch.protobufs.Script script, String defaultLang) {
+    private static Script parseFromProtoRequest(org.opensearch.protobufs.Script script, String defaultLang) {
         Objects.requireNonNull(defaultLang);
 
         if (script.hasInlineScript()) {

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/document/bulk/ActiveShardCountProtoUtils.java

@@ -13,7 +13,9 @@
 import org.opensearch.protobufs.WaitForActiveShards;
 
 /**
- * Handler for bulk requests in gRPC.
+ * Utility class for handling active shard count settings in gRPC bulk requests.
+ * This class provides methods to convert between Protocol Buffer representations
+ * and OpenSearch ActiveShardCount objects.
  */
 public class ActiveShardCountProtoUtils {
     // protected final Settings settings;
@@ -27,11 +29,13 @@ protected ActiveShardCountProtoUtils() {
 
     /**
      * Sets the active shard count on the bulk request based on the protobuf request.
-     * Similar to {@link ActiveShardCount#parseString(String)}
+     * Similar to {@link ActiveShardCount#parseString(String)}, this method interprets
+     * the wait_for_active_shards parameter from the Protocol Buffer request and applies
+     * the appropriate ActiveShardCount setting to the OpenSearch bulk request.
      *
-     * @param bulkRequest The bulk request to modify
-     * @param request The protobuf request containing the active shard count
-     * @return The modified bulk request
+     * @param bulkRequest The OpenSearch bulk request to modify
+     * @param request The Protocol Buffer request containing the active shard count settings
+     * @return The modified OpenSearch bulk request with updated active shard count settings
      */
     public static org.opensearch.action.bulk.BulkRequest getActiveShardCount(
         org.opensearch.action.bulk.BulkRequest bulkRequest,

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/CollapseBuilderProtoUtils.java

@@ -14,8 +14,10 @@
 import java.io.IOException;
 
 /**
- * Utility class for converting CollapseBuilder Protocol Buffers to objects
- *
+ * Utility class for converting CollapseBuilder Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of field collapse
+ * specifications into their corresponding OpenSearch CollapseBuilder implementations for
+ * search result field collapsing and grouping.
  */
 public class CollapseBuilderProtoUtils {
 
@@ -24,12 +26,17 @@ private CollapseBuilderProtoUtils() {
     }
 
     /**
-     * Similar to {@link CollapseBuilder#fromXContent(XContentParser)}
+     * Converts a Protocol Buffer FieldCollapse to an OpenSearch CollapseBuilder.
+     * Similar to {@link CollapseBuilder#fromXContent(XContentParser)}, this method
+     * parses the Protocol Buffer representation and creates a properly configured
+     * CollapseBuilder with the appropriate field, max concurrent group searches,
+     * and inner hits settings.
      *
-     * @param collapseProto
+     * @param collapseProto The Protocol Buffer FieldCollapse to convert
+     * @return A configured CollapseBuilder instance
+     * @throws IOException if there's an error during parsing or conversion
      */
-
-    public static CollapseBuilder fromProto(FieldCollapse collapseProto) throws IOException {
+    protected static CollapseBuilder fromProto(FieldCollapse collapseProto) throws IOException {
         CollapseBuilder collapseBuilder = new CollapseBuilder(collapseProto.getField());
 
         if (collapseProto.hasMaxConcurrentGroupSearches()) {
@@ -41,5 +48,4 @@ public static CollapseBuilder fromProto(FieldCollapse collapseProto) throws IOEx
 
         return collapseBuilder;
     }
-
 }

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/FieldAndFormatProtoUtils.java

@@ -11,8 +11,9 @@
 import org.opensearch.search.fetch.subphase.FieldAndFormat;
 
 /**
- * Utility class for converting SearchSourceBuilder Protocol Buffers to objects
- *
+ * Utility class for converting FieldAndFormat Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of field and format
+ * specifications into their corresponding OpenSearch FieldAndFormat implementations for search operations.
  */
 public class FieldAndFormatProtoUtils {
 
@@ -21,12 +22,15 @@ private FieldAndFormatProtoUtils() {
     }
 
     /**
-     * Similar to {@link FieldAndFormat#fromXContent(XContentParser)}
+     * Converts a Protocol Buffer FieldAndFormat to an OpenSearch FieldAndFormat object.
+     * Similar to {@link FieldAndFormat#fromXContent(XContentParser)}, this method
+     * parses the Protocol Buffer representation and creates a properly configured
+     * FieldAndFormat with the appropriate field name and format settings.
      *
-     * @param fieldAndFormatProto
+     * @param fieldAndFormatProto The Protocol Buffer FieldAndFormat to convert
+     * @return A configured FieldAndFormat instance
      */
-
-    public static FieldAndFormat fromProto(org.opensearch.protobufs.FieldAndFormat fieldAndFormatProto) {
+    protected static FieldAndFormat fromProto(org.opensearch.protobufs.FieldAndFormat fieldAndFormatProto) {
 
         // TODO how is this field used?
         // fieldAndFormatProto.getIncludeUnmapped();

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/HighlightBuilderProtoUtils.java

@@ -12,8 +12,9 @@
 import org.opensearch.search.fetch.subphase.highlight.HighlightBuilder;
 
 /**
- * Utility class for converting Highlight Protocol Buffers to objects
- *
+ * Utility class for converting Highlight Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of highlights
+ * into their corresponding OpenSearch HighlightBuilder implementations for search result highlighting.
  */
 public class HighlightBuilderProtoUtils {
 
@@ -22,12 +23,16 @@ private HighlightBuilderProtoUtils() {
     }
 
     /**
-     * Similar to {@link HighlightBuilder#fromXContent(XContentParser)}
+     * Converts a Protocol Buffer Highlight to an OpenSearch HighlightBuilder.
+     * Similar to {@link HighlightBuilder#fromXContent(XContentParser)}, this method
+     * would parse the Protocol Buffer representation and create a properly configured
+     * HighlightBuilder with the appropriate settings.
      *
-     * @param highlightProto
+     * @param highlightProto The Protocol Buffer Highlight to convert
+     * @return A configured HighlightBuilder instance
+     * @throws UnsupportedOperationException as highlight functionality is not yet implemented
      */
-
-    public static HighlightBuilder fromProto(Highlight highlightProto) {
+    protected static HighlightBuilder fromProto(Highlight highlightProto) {
 
         throw new UnsupportedOperationException("highlight not supported yet");
 
@@ -36,7 +41,5 @@ public static HighlightBuilder fromProto(Highlight highlightProto) {
         // TODO populate highlightBuilder
         return highlightBuilder;
         */
-
     }
-
 }

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/IndicesOptionsProtoUtils.java

@@ -39,7 +39,7 @@ private IndicesOptionsProtoUtils() {
      * @param defaultSettings the default IndicesOptions to use if not specified in the request
      * @return the IndicesOptions based on the request parameters
      */
-    public static IndicesOptions fromRequest(org.opensearch.protobufs.SearchRequest request, IndicesOptions defaultSettings) {
+    protected static IndicesOptions fromRequest(org.opensearch.protobufs.SearchRequest request, IndicesOptions defaultSettings) {
         return fromProtoParameters(request, defaultSettings);
     }
 
@@ -51,7 +51,7 @@ public static IndicesOptions fromRequest(org.opensearch.protobufs.SearchRequest
      * @param defaultSettings the default IndicesOptions to use if not specified in the request
      * @return the IndicesOptions based on the request parameters
      */
-    public static IndicesOptions fromProtoParameters(SearchRequest request, IndicesOptions defaultSettings) {
+    protected static IndicesOptions fromProtoParameters(SearchRequest request, IndicesOptions defaultSettings) {
         if (!(request.getExpandWildcardsCount() > 0)
             && !request.hasIgnoreUnavailable()
             && !request.hasAllowNoIndices()
@@ -87,7 +87,7 @@ public static IndicesOptions fromProtoParameters(SearchRequest request, IndicesO
      * @param defaultStates the default WildcardStates to use if the list is empty
      * @return an EnumSet of WildcardStates based on the provided wildcardList
      */
-    public static EnumSet<IndicesOptions.WildcardStates> parseProtoParameter(
+    protected static EnumSet<IndicesOptions.WildcardStates> parseProtoParameter(
         List<SearchRequest.ExpandWildcard> wildcardList,
         EnumSet<IndicesOptions.WildcardStates> defaultStates
     ) {
@@ -110,7 +110,7 @@ public static EnumSet<IndicesOptions.WildcardStates> parseProtoParameter(
      * @param states the EnumSet of WildcardStates to update
      * @param wildcard the ExpandWildcard value to use for updating the states
      */
-    public static void updateSetForValue(EnumSet<IndicesOptions.WildcardStates> states, SearchRequest.ExpandWildcard wildcard) {
+    protected static void updateSetForValue(EnumSet<IndicesOptions.WildcardStates> states, SearchRequest.ExpandWildcard wildcard) {
         switch (wildcard) {
             case EXPAND_WILDCARD_OPEN:
                 states.add(OPEN);

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/InnerHitsBuilderProtoUtils.java

@@ -39,8 +39,7 @@ private InnerHitsBuilderProtoUtils() {
      * @param innerHits
      * @throws IOException if there's an error during parsing
      */
-
-    public static InnerHitBuilder fromProto(List<InnerHits> innerHits) throws IOException {
+    protected static InnerHitBuilder fromProto(List<InnerHits> innerHits) throws IOException {
         InnerHitBuilder innerHitBuilder = new InnerHitBuilder();
 
         for (InnerHits innerHit : innerHits) {

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/OperatorProtoUtils.java

@@ -8,8 +8,6 @@
 
 package org.opensearch.plugin.transport.grpc.proto.request.search;
 
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import org.opensearch.index.query.Operator;
 
 /**
@@ -18,11 +16,6 @@
  * in search operations.
  */
 public class OperatorProtoUtils {
-    /**
-     * Logger for the OperatorProtoUtils class.
-     */
-    protected static Logger logger = LogManager.getLogger(OperatorProtoUtils.class);
-
     private OperatorProtoUtils() {
         // Utility class, no instances
     }
@@ -33,8 +26,7 @@ private OperatorProtoUtils() {
      * @param op
      * @return
      */
-
-    public static Operator fromEnum(org.opensearch.protobufs.SearchRequest.Operator op) {
+    protected static Operator fromEnum(org.opensearch.protobufs.SearchRequest.Operator op) {
         switch (op) {
             case OPERATOR_AND:
                 return Operator.AND;

plugins/transport-grpc/src/main/java/org/opensearch/plugin/transport/grpc/proto/request/search/PointInTimeBuilderProtoUtils.java

@@ -15,8 +15,10 @@
 import static org.opensearch.search.builder.SearchSourceBuilder.POINT_IN_TIME;
 
 /**
- * Utility class for converting SearchSourceBuilder Protocol Buffers to objects
- *
+ * Utility class for converting PointInTimeBuilder Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of point-in-time
+ * references into their corresponding OpenSearch PointInTimeBuilder implementations for
+ * search operations with consistent snapshots.
  */
 public class PointInTimeBuilderProtoUtils {
 
@@ -25,12 +27,15 @@ private PointInTimeBuilderProtoUtils() {
     }
 
     /**
-     * Similar to {@link PointInTimeBuilder#fromXContent(XContentParser)}
+     * Converts a Protocol Buffer PointInTimeReference to an OpenSearch PointInTimeBuilder.
+     * Similar to {@link PointInTimeBuilder#fromXContent(XContentParser)}, this method
+     * parses the Protocol Buffer representation and creates a properly configured
+     * PointInTimeBuilder with the appropriate ID and keep-alive settings.
      *
-     * @param pointInTime
+     * @param pointInTime The Protocol Buffer PointInTimeReference to convert
+     * @return A configured PointInTimeBuilder instance
      */
-
-    public static PointInTimeBuilder fromProto(PointInTimeReference pointInTime) {
+    protected static PointInTimeBuilder fromProto(PointInTimeReference pointInTime) {
 
         TimeValue keepAlive = TimeValue.parseTimeValue(pointInTime.getKeepAlive(), null, POINT_IN_TIME.getPreferredName());
         return new PointInTimeBuilder(pointInTime.getId()).setKeepAlive(keepAlive);