[#2155] fix: add missing @return (#2228)

### What changes were proposed in this pull request? `@return` missing description in: JdbcDatabaseOperations.java ConvertUtil.java FromIcebergPartitionSpec.java ToIcebergPartitionSpec.java IcebergTableOpsHelper.java JsonUtils.java TrinoQueryIT.java ### Why are the changes needed? For better document. Fix: #2155 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Make sure there is no missing description for `@return`. Signed-off-by: PoAn Yang <[email protected]>
apache · Feb 18, 2024 · c9d9f36 · c9d9f36
1 parent c42fb7d
commit c9d9f36
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 10 deletions.
diff --git a/...src/main/java/com/datastrato/gravitino/catalog/jdbc/operation/JdbcDatabaseOperations.java b/...src/main/java/com/datastrato/gravitino/catalog/jdbc/operation/JdbcDatabaseOperations.java
@@ -101,7 +101,7 @@ protected Connection getConnection() throws SQLException {
    * Check whether it is a system database.
    *
    * @param dbName The name of the database.
-   * @return
+   * @return false for all cases.
    */
   protected boolean isSystemDatabase(String dbName) {
     return false;

diff --git a/...c/main/java/com/datastrato/gravitino/catalog/lakehouse/iceberg/converter/ConvertUtil.java b/...c/main/java/com/datastrato/gravitino/catalog/lakehouse/iceberg/converter/ConvertUtil.java
@@ -44,7 +44,7 @@ public static Type toIcebergType(
    * Convert the nested type of Iceberg to the type of gravitino.
    *
    * @param type Iceberg type of field.
-   * @return
+   * @return Gravitino type.
    */
   public static com.datastrato.gravitino.rel.types.Type formIcebergType(Type type) {
     return TypeUtil.visit(type, new FromIcebergType());

diff --git a/...om/datastrato/gravitino/catalog/lakehouse/iceberg/converter/FromIcebergPartitionSpec.java b/...om/datastrato/gravitino/catalog/lakehouse/iceberg/converter/FromIcebergPartitionSpec.java
@@ -80,7 +80,7 @@ public Transform unknown(int fieldId, String sourceName, int sourceId, String tr
    *
    * @param partitionSpec
    * @param schema
-   * @return
+   * @return array of transforms for partition fields.
    */
   @VisibleForTesting
   public static Transform[] fromPartitionSpec(PartitionSpec partitionSpec, Schema schema) {

diff --git a/.../com/datastrato/gravitino/catalog/lakehouse/iceberg/converter/ToIcebergPartitionSpec.java b/.../com/datastrato/gravitino/catalog/lakehouse/iceberg/converter/ToIcebergPartitionSpec.java
@@ -21,7 +21,7 @@ public class ToIcebergPartitionSpec {
    * Convert iceberg table to iceberg partition spec through gravitino.
    *
    * @param icebergTable the iceberg table.
-   * @return
+   * @return a PartitionSpec
    */
   @VisibleForTesting
   public static PartitionSpec toPartitionSpec(IcebergTable icebergTable) {

diff --git a/...in/java/com/datastrato/gravitino/catalog/lakehouse/iceberg/ops/IcebergTableOpsHelper.java b/...in/java/com/datastrato/gravitino/catalog/lakehouse/iceberg/ops/IcebergTableOpsHelper.java
@@ -312,7 +312,7 @@ public IcebergTableChange buildIcebergTableChanges(
    * Therefore, we need to handle this difference here.
    *
    * @param namespace GravitinoNamespace
-   * @return
+   * @return Iceberg Namespace
    */
   public static Namespace getIcebergNamespace(com.datastrato.gravitino.Namespace namespace) {
     return getIcebergNamespace(namespace.level(namespace.length() - 1));
@@ -328,7 +328,7 @@ public static Namespace getIcebergNamespace(String... level) {
    *
    * @param namespace
    * @param name
-   * @return
+   * @return Iceberg TableIdentifier
    */
   public static TableIdentifier buildIcebergTableIdentifier(
       com.datastrato.gravitino.Namespace namespace, String name) {
@@ -341,7 +341,7 @@ public static TableIdentifier buildIcebergTableIdentifier(
    * `{namespace}.{table}`, so we need to perform truncation here.
    *
    * @param nameIdentifier GravitinoNameIdentifier
-   * @return
+   * @return Iceberg TableIdentifier
    */
   public static TableIdentifier buildIcebergTableIdentifier(NameIdentifier nameIdentifier) {
     String[] levels = nameIdentifier.namespace().levels();

diff --git a/common/src/main/java/com/datastrato/gravitino/json/JsonUtils.java b/common/src/main/java/com/datastrato/gravitino/json/JsonUtils.java
@@ -170,7 +170,7 @@ abstract static class JsonArrayIterator<T> implements Iterator<T> {
     /**
      * Judge whether it has more elements in the JSON array.
      *
-     * @return
+     * @return true if the iteration has more elements.
      */
     @Override
     public boolean hasNext() {
@@ -180,7 +180,7 @@ public boolean hasNext() {
     /**
      * Get a next element from the JSON array.
      *
-     * @return
+     * @return the next element in the iteration.
      */
     @Override
     public T next() {

diff --git a/...tion-test/src/test/java/com/datastrato/gravitino/integration/test/trino/TrinoQueryIT.java b/...tion-test/src/test/java/com/datastrato/gravitino/integration/test/trino/TrinoQueryIT.java
@@ -239,7 +239,9 @@ void executeSqlFileWithCheckResult(
    *
    * @param expectResult
    * @param result
-   * @return
+   * @return false if the expected result is empty or the actual result does not match the expected.
+   *     For {@literal <BLANK_LINE>} case, return true if the actual result is empty. For {@literal
+   *     <QUERY_FAILED>} case, replace the placeholder with "^Query \\w+ failed.*: " and do match.
    */
   static boolean match(String expectResult, String result) {
     if (expectResult.isEmpty()) {