You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by ja...@apache.org on 2019/06/17 22:02:52 UTC
[hbase] branch branch-1.4 updated: HBASE-22344 Documented the
deprecation of public and limited private APIs (#208)
This is an automated email from the ASF dual-hosted git repository.
janh pushed a commit to branch branch-1.4
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-1.4 by this push:
new 6418aba HBASE-22344 Documented the deprecation of public and limited private APIs (#208)
6418aba is described below
commit 6418abac45be8a1e2e1a781d8ee1f9873fbd9ef0
Author: Jan Hentschel <ja...@ultratendency.com>
AuthorDate: Mon Jun 17 22:02:23 2019 +0200
HBASE-22344 Documented the deprecation of public and limited private APIs (#208)
Signed-off-by: stack <st...@apache.org>
---
.../main/java/org/apache/hadoop/hbase/HTableDescriptor.java | 12 ++++++++++++
.../java/org/apache/hadoop/hbase/HBaseConfiguration.java | 6 ++++++
.../org/apache/hadoop/hbase/io/ImmutableBytesWritable.java | 4 +++-
.../src/main/java/org/apache/hadoop/hbase/util/Bytes.java | 4 +++-
.../hadoop/hbase/regionserver/RpcSchedulerFactory.java | 4 ++++
.../hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java | 4 ++++
6 files changed, 32 insertions(+), 2 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
index 7f48976..65f69b4 100644
--- 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 class HTableDescriptor implements WritableComparable<HTableDescriptor> {
.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 class HTableDescriptor implements WritableComparable<HTableDescriptor> {
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-common/src/main/java/org/apache/hadoop/hbase/HBaseConfiguration.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/HBaseConfiguration.java
index 94d4483..63c33de 100644
--- 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 class HBaseConfiguration extends Configuration {
/**
* 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
index dd7e300..a62dae7 100644
--- 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 @@ implements WritableComparable<ImmutableBytesWritable> {
/**
* @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
index 93dcafe..018b056 100644
--- 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
@@ -1334,7 +1334,9 @@ public class Bytes implements Comparable<Bytes> {
* @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
index 7bc59da..1f7f600 100644
--- 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);
}
\ No newline at end of file
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java
index 48d3d8c..e9a105e 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SimpleRpcSchedulerFactory.java
@@ -32,6 +32,10 @@ import org.apache.hadoop.hbase.ipc.SimpleRpcScheduler;
@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) {