PARQUET-2399: Use deprecated tag in Javadoc (#1222)

apache · Dec 3, 2023 · 999dcbc · 999dcbc
1 parent 97e6ba8
commit 999dcbc
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 30 deletions.
diff --git a/parquet-cli/src/main/java/org/apache/parquet/cli/commands/ColumnMaskingCommand.java b/parquet-cli/src/main/java/org/apache/parquet/cli/commands/ColumnMaskingCommand.java
@@ -40,6 +40,7 @@
 import org.apache.parquet.schema.MessageType;
 import org.slf4j.Logger;
 
+@Deprecated
 @Parameters(
     commandDescription = "(Deprecated: will be removed in 2.0.0, use rewrite command instead) "
         + "Replace columns with masked values and write to a new Parquet file")

diff --git a/parquet-cli/src/main/java/org/apache/parquet/cli/commands/PruneColumnsCommand.java b/parquet-cli/src/main/java/org/apache/parquet/cli/commands/PruneColumnsCommand.java
@@ -29,6 +29,7 @@
 import org.apache.parquet.hadoop.util.ColumnPruner;
 import org.slf4j.Logger;
 
+@Deprecated
 @Parameters(
     commandDescription = "(Deprecated: will be removed in 2.0.0, use rewrite command instead) "
         + "Prune column(s) in a Parquet file and save it to a new file. "

diff --git a/parquet-cli/src/main/java/org/apache/parquet/cli/commands/TransCompressionCommand.java b/parquet-cli/src/main/java/org/apache/parquet/cli/commands/TransCompressionCommand.java
@@ -40,6 +40,7 @@
 import org.apache.parquet.schema.MessageType;
 import org.slf4j.Logger;
 
+@Deprecated
 @Parameters(
     commandDescription = "(Deprecated: will be removed in 2.0.0, use rewrite command instead) "
         + "Translate the compression from one to another (It doesn't support bloom filter feature yet).")

diff --git a/parquet-column/src/main/java/org/apache/parquet/schema/LogicalTypeAnnotation.java b/parquet-column/src/main/java/org/apache/parquet/schema/LogicalTypeAnnotation.java
@@ -150,10 +150,9 @@ protected LogicalTypeAnnotation fromString(List<String> params) {
    * Those logical type implementations, which don't have a corresponding mapping should return null.
    * <p>
    * API should be considered private
-   * <p>
-   * Deprecated: Please use the LogicalTypeAnnotation itself
    *
    * @return the OriginalType representation of the new logical type, or null if there's none
+   * @deprecated Please use the LogicalTypeAnnotation itself
    */
   @Deprecated
   public abstract OriginalType toOriginalType();
@@ -317,10 +316,9 @@ private StringLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -362,10 +360,9 @@ private MapLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -402,10 +399,9 @@ private ListLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -442,10 +438,9 @@ private EnumLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -501,10 +496,9 @@ public int getScale() {
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -560,10 +554,9 @@ private DateLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -615,10 +608,9 @@ private TimeLogicalTypeAnnotation(boolean isAdjustedToUTC, TimeUnit unit) {
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -701,10 +693,9 @@ private TimestampLogicalTypeAnnotation(boolean isAdjustedToUTC, TimeUnit unit) {
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -794,10 +785,9 @@ private IntLogicalTypeAnnotation(int bitWidth, boolean isSigned) {
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -872,10 +862,9 @@ private JsonLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -917,10 +906,9 @@ private BsonLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -963,10 +951,9 @@ private UUIDLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -1005,10 +992,9 @@ private IntervalLogicalTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated
@@ -1062,10 +1048,9 @@ private MapKeyValueTypeAnnotation() {}
 
     /**
      * API Should be considered private
-     * <p>
-     * Deprecated: Please use the LogicalTypeAnnotation itself
      *
      * @return the original type
+     * @deprecated Please use the LogicalTypeAnnotation itself
      */
     @Override
     @Deprecated