HBASE-22344 Documented the deprecation of public and limited private …

…APIs (#208) Signed-off-by: stack <stack@apache.org>
apache · Jun 17, 2019 · 55e2a36 · 55e2a36
1 parent 9472d6e
commit 55e2a36
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 4 deletions.
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/HTableDescriptor.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/HTableDescriptor.java
@@ -1602,11 +1602,19 @@ public static Path getTableDir(Path rootdir, final byte [] tableName) {
               .setCacheDataInL1(true)
       });
 
+  /**
+   * @deprecated since 0.94.1
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-6188">HBASE-6188</a>
+   */
   @Deprecated
   public HTableDescriptor setOwner(User owner) {
     return setOwnerString(owner != null ? owner.getShortName() : null);
   }
 
+  /**
+   * @deprecated since 0.94.1
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-6188">HBASE-6188</a>
+   */
   // used by admin.rb:alter(table_name,*args) to update owner.
   @Deprecated
   public HTableDescriptor setOwnerString(String ownerString) {
@@ -1618,6 +1626,10 @@ public HTableDescriptor setOwnerString(String ownerString) {
     return this;
   }
 
+  /**
+   * @deprecated since 0.94.1
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-6188">HBASE-6188</a>
+   */
   @Deprecated
   public String getOwnerString() {
     if (getValue(OWNER_KEY) != null) {

diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Admin.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Admin.java
@@ -733,7 +733,7 @@ boolean setBalancerRunning(final boolean on, final boolean synchronous)
    * @throws IOException if a remote or network exception occurs
    */
   boolean balancer(boolean force) throws IOException;
-  
+
   /**
    * Query the current state of the balancer
    *
@@ -1482,7 +1482,7 @@ List<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
    * @throws IOException if a remote or network exception occurs
    */
   void deleteSnapshots(final Pattern pattern) throws IOException;
-  
+
   /**
    * Delete all existing snapshots matching the given table name regular expression and snapshot
    * name regular expression.

diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/HBaseConfiguration.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/HBaseConfiguration.java
@@ -42,6 +42,9 @@ public class HBaseConfiguration extends Configuration {
   /**
    * Instantiating HBaseConfiguration() is deprecated. Please use
    * HBaseConfiguration#create() to construct a plain Configuration
+   * @deprecated since 0.90.0. Please use {@link #create()} instead.
+   * @see #create()
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-2036">HBASE-2036</a>
    */
   @Deprecated
   public HBaseConfiguration() {
@@ -55,6 +58,9 @@ public HBaseConfiguration() {
   /**
    * Instantiating HBaseConfiguration() is deprecated. Please use
    * HBaseConfiguration#create(conf) to construct a plain Configuration
+   * @deprecated since 0.90.0. Please use {@link #create(Configuration)} instead.
+   * @see #create(Configuration)
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-2036">HBASE-2036</a>
    */
   @Deprecated
   public HBaseConfiguration(final Configuration c) {

diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/io/ImmutableBytesWritable.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/io/ImmutableBytesWritable.java
@@ -119,7 +119,9 @@ public void set(final byte [] b, final int offset, final int length) {
 
   /**
    * @return the number of valid bytes in the buffer
-   * @deprecated use {@link #getLength()} instead
+   * @deprecated since 0.98.5. Use {@link #getLength()} instead
+   * @see #getLength()
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-11561">HBASE-11561</a>
    */
   @Deprecated
   public int getSize() {

diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Bytes.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Bytes.java
@@ -1292,7 +1292,9 @@ public static long bytesToVint(final byte [] buffer) {
    * @param offset Offset into array at which vint begins.
    * @throws java.io.IOException e
    * @return deserialized long from buffer.
-   * @deprecated Use {@link #readAsVLong(byte[],int)} instead.
+   * @deprecated since 0.98.12. Use {@link #readAsVLong(byte[],int)} instead.
+   * @see #readAsVLong(byte[], int)
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-6919">HBASE-6919</a>
    */
   @Deprecated
   public static long readVLong(final byte [] buffer, final int offset)

diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RpcSchedulerFactory.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RpcSchedulerFactory.java
@@ -36,6 +36,10 @@ public interface RpcSchedulerFactory {
    */
   RpcScheduler create(Configuration conf, PriorityFunction priority, Abortable server);
 
+  /**
+   * @deprecated since 1.0.0.
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-12028">HBASE-12028</a>
+   */
   @Deprecated
   RpcScheduler create(Configuration conf, PriorityFunction priority);
 }
diff --git a/...-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java b/...-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java
@@ -32,6 +32,10 @@
 @InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})
 @InterfaceStability.Evolving
 public class SimpleRpcSchedulerFactory implements RpcSchedulerFactory {
+  /**
+   * @deprecated since 1.0.0.
+   * @see <a href="https://issues.apache.org/jira/browse/HBASE-12028">HBASE-12028</a>
+   */
   @Override
   @Deprecated
   public RpcScheduler create(Configuration conf, PriorityFunction priority) {