From 3f62e481e2556085e1d9c9b3273aecbcfed7b308 Mon Sep 17 00:00:00 2001 From: Jan Hentschel Date: Mon, 17 Jun 2019 22:02:23 +0200 Subject: [PATCH] HBASE-22344 Documented the deprecation of public and limited private APIs (#208) Signed-off-by: stack --- .../hadoop/hbase/HColumnDescriptor.java | 5 +- .../apache/hadoop/hbase/HTableDescriptor.java | 24 +++++++-- .../org/apache/hadoop/hbase/client/Admin.java | 13 +++-- .../hadoop/hbase/client/AsyncAdmin.java | 3 +- .../org/apache/hadoop/hbase/client/Scan.java | 51 +++++++++++++------ .../hbase/client/SnapshotDescription.java | 26 ++++++++-- .../hadoop/hbase/client/TableDescriptor.java | 4 ++ .../hbase/client/TableDescriptorBuilder.java | 20 ++++++++ ...FirstKeyValueMatchingQualifiersFilter.java | 3 +- .../hadoop/hbase/HBaseConfiguration.java | 8 ++- .../hbase/io/ImmutableBytesWritable.java | 4 +- .../org/apache/hadoop/hbase/util/Bytes.java | 18 +++++-- .../org/apache/hadoop/hbase/util/Counter.java | 5 +- .../hbase/mapred/TableOutputFormat.java | 6 ++- .../hadoop/hbase/mapreduce/CellCreator.java | 2 + .../hbase/mapreduce/HFileOutputFormat2.java | 5 +- .../SimpleTotalOrderPartitioner.java | 9 ++++ .../hbase/mapreduce/TableMapReduceUtil.java | 10 +++- .../hbase/replication/ReplicationPeer.java | 5 +- .../regionserver/RowTooBigException.java | 4 +- .../regionserver/RpcSchedulerFactory.java | 4 ++ .../SimpleRpcSchedulerFactory.java | 4 ++ .../hbase/regionserver/StoreFileReader.java | 14 ++--- .../security/access/AccessController.java | 2 +- .../org/apache/hadoop/hbase/wal/WALEdit.java | 10 +++- .../apache/hadoop/hbase/HBaseTestCase.java | 5 +- .../hadoop/hbase/HBaseTestingUtility.java | 30 +++++++++-- 27 files changed, 232 insertions(+), 62 deletions(-) diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java index 70392087513..a2039360acc 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java @@ -162,7 +162,10 @@ public class HColumnDescriptor implements ColumnFamilyDescriptor, Comparableb can be null when deserializing). Cannot start with a '.' * either. Also Family can not be an empty value or equal "recovered.edits". - * @deprecated Use {@link ColumnFamilyDescriptorBuilder#isLegalColumnFamilyName(byte[])}. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link ColumnFamilyDescriptorBuilder#isLegalColumnFamilyName(byte[])} instead. + * @see ColumnFamilyDescriptorBuilder#isLegalColumnFamilyName(byte[]) + * @see HBASE-18008 */ @Deprecated public static byte [] isLegalFamilyName(final byte [] b) { 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 8cb17a6d59b..5d258df6ef4 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 @@ -551,9 +551,11 @@ public class HTableDescriptor implements TableDescriptor, ComparableHBASE-18008 */ @Deprecated public Collection getFamilies() { @@ -660,8 +662,9 @@ public class HTableDescriptor implements TableDescriptor, ComparableHBASE-18008 */ @Deprecated @Override @@ -677,7 +680,10 @@ public class HTableDescriptor implements TableDescriptor, ComparableHBASE-18008 */ @Deprecated public HColumnDescriptor getFamily(final byte[] column) { @@ -800,12 +806,20 @@ public class HTableDescriptor implements TableDescriptor, ComparableHBASE-6188 + */ @Deprecated public HTableDescriptor setOwner(User owner) { getDelegateeForModification().setOwner(owner); return this; } + /** + * @deprecated since 0.94.1 + * @see HBASE-6188 + */ // used by admin.rb:alter(table_name,*args) to update owner. @Deprecated public HTableDescriptor setOwnerString(String ownerString) { @@ -813,6 +827,10 @@ public class HTableDescriptor implements TableDescriptor, ComparableHBASE-6188 + */ @Override @Deprecated public String getOwnerString() { 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 index 2ea69879573..d17b709be4f 100644 --- 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 @@ -1726,9 +1726,11 @@ public interface Admin extends Abortable, Closeable { * Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2. * @param procId ID of the procedure to abort * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted? - * @return true if aborted, false if procedure already completed or does not exist - * @throws IOException - * @deprecated Since 2.1.1 -- to be removed. + * @return true if aborted, false if procedure already completed or does + * not exist + * @throws IOException if a remote or network exception occurs + * @deprecated since 2.1.1 and will be removed in 4.0.0. + * @see HBASE-21223 */ @Deprecated boolean abortProcedure( @@ -1746,8 +1748,9 @@ public interface Admin extends Abortable, Closeable { * @param procId ID of the procedure to abort * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted? * @return true if aborted, false if procedure already completed or does not exist - * @throws IOException - * @deprecated Since 2.1.1 -- to be removed. + * @throws IOException if a remote or network exception occurs + * @deprecated since 2.1.1 and will be removed in 4.0.0. + * @see HBASE-21223 */ @Deprecated Future abortProcedureAsync( diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncAdmin.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncAdmin.java index fe00df089e7..84bf3c15116 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncAdmin.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncAdmin.java @@ -864,7 +864,8 @@ public interface AsyncAdmin { * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted? * @return true if aborted, false if procedure already completed or does not exist. the value is * wrapped by {@link CompletableFuture} - * @deprecated Since 2.1.1 -- to be removed. + * @deprecated since 2.1.1 and will be removed in 4.0.0. + * @see HBASE-21223 */ @Deprecated CompletableFuture abortProcedure(long procId, boolean mayInterruptIfRunning); diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java index d4aff047a3c..5e57799c994 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java @@ -196,7 +196,9 @@ public class Scan extends Query { public Scan() {} /** - * @deprecated use {@code new Scan().withStartRow(startRow).setFilter(filter)} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@code new Scan().withStartRow(startRow).setFilter(filter)} instead. + * @see HBASE-17320 */ @Deprecated public Scan(byte[] startRow, Filter filter) { @@ -210,7 +212,9 @@ public class Scan extends Query { * If the specified row does not exist, the Scanner will start from the next closest row after the * specified row. * @param startRow row to start scanner at or after - * @deprecated use {@code new Scan().withStartRow(startRow)} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@code new Scan().withStartRow(startRow)} instead. + * @see HBASE-17320 */ @Deprecated public Scan(byte[] startRow) { @@ -221,7 +225,9 @@ public class Scan extends Query { * Create a Scan operation for the range of rows specified. * @param startRow row to start scanner at or after (inclusive) * @param stopRow row to stop scanner before (exclusive) - * @deprecated use {@code new Scan().withStartRow(startRow).withStopRow(stopRow)} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@code new Scan().withStartRow(startRow).withStopRow(stopRow)} instead. + * @see HBASE-17320 */ @Deprecated public Scan(byte[] startRow, byte[] stopRow) { @@ -423,8 +429,11 @@ public class Scan extends Query { * @return this * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length * exceeds {@link HConstants#MAX_ROW_LENGTH}) - * @deprecated use {@link #withStartRow(byte[])} instead. This method may change the inclusive of - * the stop row to keep compatible with the old behavior. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #withStartRow(byte[])} + * instead. This method may change the inclusive of the stop row to keep compatible with the old + * behavior. + * @see #withStartRow(byte[]) + * @see HBASE-17320 */ @Deprecated public Scan setStartRow(byte[] startRow) { @@ -483,8 +492,11 @@ public class Scan extends Query { * @return this * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length * exceeds {@link HConstants#MAX_ROW_LENGTH}) - * @deprecated use {@link #withStopRow(byte[])} instead. This method may change the inclusive of - * the stop row to keep compatible with the old behavior. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #withStopRow(byte[])} instead. + * This method may change the inclusive of the stop row to keep compatible with the old + * behavior. + * @see #withStopRow(byte[]) + * @see HBASE-17320 */ @Deprecated public Scan setStopRow(byte[] stopRow) { @@ -601,8 +613,10 @@ public class Scan extends Query { /** * Get all available versions. * @return this - * @deprecated It is easy to misunderstand with column family's max versions, so use - * {@link #readAllVersions()} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. It is easy to misunderstand with column + * family's max versions, so use {@link #readAllVersions()} instead. + * @see #readAllVersions() + * @see HBASE-17125 */ @Deprecated public Scan setMaxVersions() { @@ -613,8 +627,10 @@ public class Scan extends Query { * Get up to the specified number of versions of each column. * @param maxVersions maximum versions for each column * @return this - * @deprecated It is easy to misunderstand with column family's max versions, so use - * {@link #readVersions(int)} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. It is easy to misunderstand with column + * family's max versions, so use {@link #readVersions(int)} instead. + * @see #readVersions(int) + * @see HBASE-17125 */ @Deprecated public Scan setMaxVersions(int maxVersions) { @@ -1037,12 +1053,13 @@ public class Scan extends Query { * better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one * data block(64KB), it could be considered as a small scan. * @param small - * @deprecated since 2.0.0. Use {@link #setLimit(int)} and {@link #setReadType(ReadType)} instead. - * And for the one rpc optimization, now we will also fetch data when openScanner, and - * if the number of rows reaches the limit then we will close the scanner - * automatically which means we will fall back to one rpc. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #setLimit(int)} and + * {@link #setReadType(ReadType)} instead. And for the one rpc optimization, now we will also + * fetch data when openScanner, and if the number of rows reaches the limit then we will close + * the scanner automatically which means we will fall back to one rpc. * @see #setLimit(int) * @see #setReadType(ReadType) + * @see HBASE-17045 */ @Deprecated public Scan setSmall(boolean small) { @@ -1054,7 +1071,9 @@ public class Scan extends Query { /** * Get whether this scan is a small scan * @return true if small scan - * @deprecated since 2.0.0. See the comment of {@link #setSmall(boolean)} + * @deprecated since 2.0.0 and will be removed in 3.0.0. See the comment of + * {@link #setSmall(boolean)} + * @see HBASE-17045 */ @Deprecated public boolean isSmall() { diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/SnapshotDescription.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/SnapshotDescription.java index db62c431f59..0b6f196d615 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/SnapshotDescription.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/SnapshotDescription.java @@ -37,7 +37,10 @@ public class SnapshotDescription { } /** - * @deprecated Use the version with the TableName instance instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName + * instance instead. + * @see #SnapshotDescription(String, TableName) + * @see HBASE-16892 */ @Deprecated public SnapshotDescription(String name, String table) { @@ -49,7 +52,10 @@ public class SnapshotDescription { } /** - * @deprecated Use the version with the TableName instance instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName + * instance instead. + * @see #SnapshotDescription(String, TableName, SnapshotType) + * @see HBASE-16892 */ @Deprecated public SnapshotDescription(String name, String table, SnapshotType type) { @@ -61,7 +67,10 @@ public class SnapshotDescription { } /** - * @deprecated Use the version with the TableName instance instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName + * instance instead. + * @see #SnapshotDescription(String, TableName, SnapshotType, String) + * @see HBASE-16892 */ @Deprecated public SnapshotDescription(String name, String table, SnapshotType type, String owner) { @@ -73,7 +82,10 @@ public class SnapshotDescription { } /** - * @deprecated Use the version with the TableName instance instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName + * instance instead. + * @see #SnapshotDescription(String, TableName, SnapshotType, String, long, int) + * @see HBASE-16892 */ @Deprecated public SnapshotDescription(String name, String table, SnapshotType type, String owner, @@ -96,7 +108,11 @@ public class SnapshotDescription { } /** - * @deprecated Use getTableName() or getTableNameAsString() instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #getTableName()} or + * {@link #getTableNameAsString()} instead. + * @see #getTableName() + * @see #getTableNameAsString() + * @see HBASE-16892 */ @Deprecated public String getTable() { diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptor.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptor.java index 60aee714dbe..317bccb0507 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptor.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptor.java @@ -191,6 +191,10 @@ public interface TableDescriptor { */ TableName getTableName(); + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ @Deprecated String getOwnerString(); diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java index c54b8842250..ac150a6f1bd 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java @@ -452,12 +452,20 @@ public class TableDescriptorBuilder { return this; } + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ @Deprecated public TableDescriptorBuilder setOwner(User owner) { desc.setOwner(owner); return this; } + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ @Deprecated public TableDescriptorBuilder setOwnerString(String ownerString) { desc.setOwnerString(ownerString); @@ -1453,17 +1461,29 @@ public class TableDescriptorBuilder { } } + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ @Deprecated public ModifyableTableDescriptor setOwner(User owner) { return setOwnerString(owner != null ? owner.getShortName() : null); } + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ // used by admin.rb:alter(table_name,*args) to update owner. @Deprecated public ModifyableTableDescriptor setOwnerString(String ownerString) { return setValue(OWNER_KEY, ownerString); } + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. + * @see HBASE-15583 + */ @Override @Deprecated public String getOwnerString() { diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java index 4cde2bfcdee..ed119494cce 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java @@ -43,7 +43,8 @@ import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations; * caveat, this filter is only useful for special cases * like org.apache.hadoop.hbase.mapreduce.RowCounter. *

- * @deprecated Deprecated in 2.0. See HBASE-13347 + * @deprecated Deprecated in 2.0.0 and will be removed in 3.0.0. + * @see HBASE-13347 */ @InterfaceAudience.Public @Deprecated 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 02c36ab4526..85c038fcf6e 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 @@ -39,7 +39,9 @@ public class HBaseConfiguration extends Configuration { /** * Instantiating HBaseConfiguration() is deprecated. Please use * HBaseConfiguration#create() to construct a plain Configuration - * @deprecated Please use create() instead. + * @deprecated since 0.90.0. Please use {@link #create()} instead. + * @see #create() + * @see HBASE-2036 */ @Deprecated public HBaseConfiguration() { @@ -53,7 +55,9 @@ public class HBaseConfiguration extends Configuration { /** * Instantiating HBaseConfiguration() is deprecated. Please use * HBaseConfiguration#create(conf) to construct a plain Configuration - * @deprecated Please user create(conf) instead. + * @deprecated since 0.90.0. Please use {@link #create(Configuration)} instead. + * @see #create(Configuration) + * @see HBASE-2036 */ @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 949e905a69c..d810c4ae9aa 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 @@ -117,7 +117,9 @@ implements WritableComparable { /** * @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 HBASE-11561 */ @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 9c3049fe71b..c77ceda63f4 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 @@ -226,7 +226,9 @@ public class Bytes implements Comparable { /** * @return the number of valid bytes in the buffer - * @deprecated use {@link #getLength()} instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #getLength()} instead. + * @see #getLength() + * @see HBASE-11862 */ @Deprecated public int getSize() { @@ -1319,7 +1321,9 @@ public class Bytes implements Comparable { * @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 HBASE-6919 */ @Deprecated public static long readVLong(final byte [] buffer, final int offset) @@ -2102,7 +2106,10 @@ public class Bytes implements Comparable { * arr[-1] = -Inf and arr[N] = Inf for an N-element array. The above * means that this function can return 2N + 1 different values * ranging from -(N + 1) to N - 1. - * @deprecated {@link Bytes#binarySearch(byte[][], byte[], int, int)} + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #binarySearch(byte[][], byte[], int, int)} instead. + * @see #binarySearch(byte[][], byte[], int, int) + * @see HBASE-13450 */ @Deprecated public static int binarySearch(byte [][]arr, byte []key, int offset, @@ -2160,7 +2167,10 @@ public class Bytes implements Comparable { * means that this function can return 2N + 1 different values * ranging from -(N + 1) to N - 1. * @return the index of the block - * @deprecated Use {@link Bytes#binarySearch(Cell[], Cell, CellComparator)} + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #binarySearch(Cell[], Cell, CellComparator)} instead. + * @see #binarySearch(Cell[], Cell, CellComparator) + * @see HBASE-13450 */ @Deprecated public static int binarySearch(byte[][] arr, Cell key, RawComparator comparator) { diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Counter.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Counter.java index d646f4592a9..2d97405c0aa 100644 --- a/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Counter.java +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/util/Counter.java @@ -25,7 +25,10 @@ import org.apache.yetus.audience.InterfaceAudience; /** * High scalable counter. Thread safe. - * @deprecated use {@link java.util.concurrent.atomic.LongAdder} instead. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link java.util.concurrent.atomic.LongAdder} instead. + * @see java.util.concurrent.atomic.LongAdder + * @see HBASE-7612 */ @InterfaceAudience.Public @Deprecated diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java index ed619fd7ff2..fcf6f552b7a 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java @@ -57,8 +57,10 @@ public class TableOutputFormat extends FileOutputFormatHBASE-16774 */ @Deprecated public TableRecordWriter(final BufferedMutator mutator) throws IOException { diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/CellCreator.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/CellCreator.java index e744967fa36..6c69651d0a4 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/CellCreator.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/CellCreator.java @@ -87,6 +87,8 @@ public class CellCreator { * @param visExpression visibility expression to be associated with cell * @return created Cell * @throws IOException + * @deprecated since 0.98.9 + * @see HBASE-10560 */ @Deprecated public Cell create(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.java index 6bfaef7b508..dc293568769 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.java @@ -118,7 +118,10 @@ public class HFileOutputFormat2 /** * The modification for the returned HTD doesn't affect the inner TD. * @return A clone of inner table descriptor - * @deprecated use {@link #getTableDescriptor} + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #getTableDescriptor()} + * instead. + * @see #getTableDescriptor() + * @see HBASE-18241 */ @Deprecated public HTableDescriptor getHTableDescriptor() { diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/SimpleTotalOrderPartitioner.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/SimpleTotalOrderPartitioner.java index 1d6308adc66..df07780737a 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/SimpleTotalOrderPartitioner.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/SimpleTotalOrderPartitioner.java @@ -49,8 +49,17 @@ public class SimpleTotalOrderPartitioner extends PartitionerHBASE-1923 + */ @Deprecated public static final String START = "hbase.simpletotalorder.start"; + + /** + * @deprecated since 0.90.0 + * @see HBASE-1923 + */ @Deprecated public static final String END = "hbase.simpletotalorder.end"; diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.java index ce9f93ae2aa..7098e248882 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.java @@ -552,7 +552,10 @@ public class TableMapReduceUtil { * @param job The job that requires the permission. * @param quorumAddress string that contains the 3 required configuratins * @throws IOException When the authentication token cannot be obtained. - * @deprecated Since 1.2.0, use {@link #initCredentialsForCluster(Job, Configuration)} instead. + * @deprecated Since 1.2.0 and will be removed in 3.0.0. Use + * {@link #initCredentialsForCluster(Job, Configuration)} instead. + * @see #initCredentialsForCluster(Job, Configuration) + * @see HBASE-14886 */ @Deprecated public static void initCredentialsForCluster(Job job, String quorumAddress) @@ -876,7 +879,10 @@ public class TableMapReduceUtil { * Add the jars containing the given classes to the job's configuration * such that JobClient will ship them to the cluster and add them to * the DistributedCache. - * @deprecated rely on {@link #addDependencyJars(Job)} instead. + * @deprecated since 1.3.0 and will be removed in 3.0.0. Use {@link #addDependencyJars(Job)} + * instead. + * @see #addDependencyJars(Job) + * @see HBASE-8386 */ @Deprecated public static void addDependencyJars(Configuration conf, diff --git a/hbase-replication/src/main/java/org/apache/hadoop/hbase/replication/ReplicationPeer.java b/hbase-replication/src/main/java/org/apache/hadoop/hbase/replication/ReplicationPeer.java index 2da3cce9402..f1103b268e9 100644 --- a/hbase-replication/src/main/java/org/apache/hadoop/hbase/replication/ReplicationPeer.java +++ b/hbase-replication/src/main/java/org/apache/hadoop/hbase/replication/ReplicationPeer.java @@ -98,7 +98,10 @@ public interface ReplicationPeer { void registerPeerConfigListener(ReplicationPeerConfigListener listener); /** - * @deprecated Use {@link #registerPeerConfigListener(ReplicationPeerConfigListener)} instead. + * @deprecated since 2.1.0 and will be removed in 4.0.0. Use + * {@link #registerPeerConfigListener(ReplicationPeerConfigListener)} instead. + * @see #registerPeerConfigListener(ReplicationPeerConfigListener) + * @see HBASE-19573 */ @Deprecated default void trackPeerConfigChanges(ReplicationPeerConfigListener listener) { diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowTooBigException.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowTooBigException.java index 4e3281101b2..9cbf748f90d 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowTooBigException.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowTooBigException.java @@ -25,7 +25,9 @@ import org.apache.yetus.audience.InterfaceAudience; * set and row size appears to exceed max configured size (configurable via * hbase.table.max.rowsize). * - * @deprecated use {@link org.apache.hadoop.hbase.client.RowTooBigException} instead. + * @deprecated since 0.99.0. Use {@link org.apache.hadoop.hbase.client.RowTooBigException} instead. + * @see org.apache.hadoop.hbase.client.RowTooBigException + * @see HBASE-11893 */ @InterfaceAudience.Public @Deprecated 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 4e63f430e22..dbd393db988 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 HBASE-12028 + */ @Deprecated RpcScheduler create(Configuration conf, PriorityFunction priority); } 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 67aad268097..22a9da548d6 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 HBASE-12028 + */ @Override @Deprecated public RpcScheduler create(Configuration conf, PriorityFunction priority) { diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileReader.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileReader.java index 0a4efb033a6..5c76c0b44b3 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileReader.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileReader.java @@ -191,13 +191,14 @@ public class StoreFileReader { } /** - * @deprecated Do not write further code which depends on this call. Instead - * use getStoreFileScanner() which uses the StoreFileScanner class/interface - * which is the preferred way to scan a store with higher level concepts. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends + * on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner + * class/interface which is the preferred way to scan a store with higher level concepts. * * @param cacheBlocks should we cache the blocks? * @param pread use pread (for concurrent small readers) * @return the underlying HFileScanner + * @see HBASE-15296 */ @Deprecated public HFileScanner getScanner(boolean cacheBlocks, boolean pread) { @@ -205,9 +206,9 @@ public class StoreFileReader { } /** - * @deprecated Do not write further code which depends on this call. Instead - * use getStoreFileScanner() which uses the StoreFileScanner class/interface - * which is the preferred way to scan a store with higher level concepts. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends + * on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner + * class/interface which is the preferred way to scan a store with higher level concepts. * * @param cacheBlocks * should we cache the blocks? @@ -216,6 +217,7 @@ public class StoreFileReader { * @param isCompaction * is scanner being used for compaction? * @return the underlying HFileScanner + * @see HBASE-15296 */ @Deprecated public HFileScanner getScanner(boolean cacheBlocks, boolean pread, diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java index 275201c91bd..bebf16cadba 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java @@ -2460,7 +2460,7 @@ public class AccessController implements MasterCoprocessor, RegionCoprocessor, throws IOException { requirePermission(ctx, "replicateLogEntries", Action.WRITE); } - + @Override public void preClearCompactionQueues(ObserverContext ctx) throws IOException { diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALEdit.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALEdit.java index 3d90a45f744..d79ff8a6dab 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALEdit.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALEdit.java @@ -94,7 +94,10 @@ public class WALEdit implements HeapSize { } /** - * @deprecated Since 2.0.1. Use {@link #WALEdit(int, boolean)} instead. + * @deprecated since 2.0.1 and will be removed in 4.0.0. Use {@link #WALEdit(int, boolean)} + * instead. + * @see #WALEdit(int, boolean) + * @see HBASE-20781 */ @Deprecated public WALEdit(boolean isReplay) { @@ -102,7 +105,10 @@ public class WALEdit implements HeapSize { } /** - * @deprecated Since 2.0.1. Use {@link #WALEdit(int, boolean)} instead. + * @deprecated since 2.0.1 and will be removed in 4.0.0. Use {@link #WALEdit(int, boolean)} + * instead. + * @see #WALEdit(int, boolean) + * @see HBASE-20781 */ @Deprecated public WALEdit(int cellCount) { diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestCase.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestCase.java index 706a75f287d..7d296fa0e5c 100644 --- a/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestCase.java +++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestCase.java @@ -47,7 +47,10 @@ import junit.framework.TestCase; /** * Abstract HBase test class. Initializes a few things that can come in handly * like an HBaseConfiguration and filesystem. - * @deprecated Write junit4 unit tests using {@link HBaseTestingUtility} + * @deprecated since 2.0.0 and will be removed in 3.0.0. Write junit4 unit tests using + * {@link HBaseTestingUtility}. + * @see HBaseTestingUtility + * @see HBASE-11912 */ @Deprecated public abstract class HBaseTestCase extends TestCase { diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java index 512cca0c10c..d7522b5188a 100644 --- a/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java +++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java @@ -181,7 +181,8 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { * System property key to get test directory value. Name is as it is because mini dfs has * hard-codings to put test data here. It should NOT be used directly in HBase, as it's a property * used in mini dfs. - * @deprecated can be used only with mini dfs + * @deprecated since 2.0.0 and will be removed in 3.0.0. Can be used only with mini dfs. + * @see HBASE-19410 */ @Deprecated private static final String TEST_DIRECTORY_KEY = "test.build.data"; @@ -357,8 +358,11 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { } /** - * @deprecated use {@link HBaseTestingUtility#HBaseTestingUtility()} instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #HBaseTestingUtility()} + * instead. * @return a normal HBaseTestingUtility + * @see #HBaseTestingUtility() + * @see HBASE-19841 */ @Deprecated public static HBaseTestingUtility createLocalHTU() { @@ -366,8 +370,11 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { } /** - * @deprecated use {@link HBaseTestingUtility#HBaseTestingUtility(Configuration)} instead + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #HBaseTestingUtility(Configuration)} instead. * @return a normal HBaseTestingUtility + * @see #HBaseTestingUtility(Configuration) + * @see HBASE-19841 */ @Deprecated public static HBaseTestingUtility createLocalHTU(Configuration c) { @@ -1770,6 +1777,12 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { public static final byte [] START_KEY_BYTES = {FIRST_CHAR, FIRST_CHAR, FIRST_CHAR}; public static final String START_KEY = new String(START_KEY_BYTES, HConstants.UTF8_CHARSET); + /** + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #createTableDescriptor(TableName, int, int, int, KeepDeletedCells)} instead. + * @see #createTableDescriptor(TableName, int, int, int, KeepDeletedCells) + * @see HBASE-13893 + */ @Deprecated public HTableDescriptor createTableDescriptor(final String name, final int minVersions, final int versions, final int ttl, KeepDeletedCells keepDeleted) { @@ -1781,6 +1794,10 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { * Create a table of name name. * @param name Name to give table. * @return Column descriptor. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #createTableDescriptor(TableName, int, int, int, KeepDeletedCells)} instead. + * @see #createTableDescriptor(TableName, int, int, int, KeepDeletedCells) + * @see HBASE-13893 */ @Deprecated public HTableDescriptor createTableDescriptor(final String name) { @@ -1882,8 +1899,11 @@ public class HBaseTestingUtility extends HBaseZKTestingUtility { * @throws IOException * @return A region on which you must call {@link HBaseTestingUtility#closeRegionAndWAL(HRegion)} when done. - * @deprecated use - * {@link #createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)} + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use + * {@link #createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)} + * instead. + * @see #createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...) + * @see HBASE-13893 */ @Deprecated public HRegion createLocalHRegion(byte[] tableName, byte[] startKey, byte[] stopKey,