HBASE-22344 Documented the deprecation of public and limited private APIs (#208)

Signed-off-by: stack <stack@apache.org>
This commit is contained in:
Jan Hentschel 2019-06-17 22:02:23 +02:00
parent 9472d6e968
commit 55e2a36a58
No known key found for this signature in database
GPG Key ID: 5CD818B19CC299A3
7 changed files with 34 additions and 4 deletions

View File

@ -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) {

View File

@ -733,7 +733,7 @@ public interface Admin extends Abortable, Closeable {
* @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 @@ public interface Admin extends Abortable, Closeable {
* @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.

View File

@ -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) {

View File

@ -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() {

View File

@ -1292,7 +1292,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)

View File

@ -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);
}

View File

@ -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) {