From 3eff02a8f37c359337f53eee48ad4f0d2b001b72 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/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 +++- .../regionserver/RowTooBigException.java | 4 +- .../regionserver/RpcSchedulerFactory.java | 4 ++ .../SimpleRpcSchedulerFactory.java | 4 ++ .../hbase/regionserver/StoreFileReader.java | 14 ++--- .../org/apache/hadoop/hbase/wal/WALEdit.java | 10 +++- .../apache/hadoop/hbase/HBaseTestCase.java | 5 +- .../hadoop/hbase/HBaseTestingUtility.java | 30 +++++++++-- 23 files changed, 217 insertions(+), 54 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 70392087513d..a2039360acc0 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 @@ protected HColumnDescriptor(ModifyableColumnFamilyDescriptor delegate) { * name: i.e. 'printable' and ends in a ':' (Null passes are allowed because * b 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 4f3c24e7c75a..90510e89a708 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 @@ -527,9 +527,11 @@ public int compareTo(final HTableDescriptor other) { /** * Returns an unmodifiable collection of all the {@link HColumnDescriptor} * of all the column families of the table. - * @deprecated Use {@link #getColumnFamilies}. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #getColumnFamilies()} instead. * @return Immutable collection of {@link HColumnDescriptor} of all the * column families. + * @see #getColumnFamilies() + * @see HBASE-18008 */ @Deprecated public Collection getFamilies() { @@ -636,8 +638,9 @@ public int getColumnFamilyCount() { * of the table. * * @return Array of all the HColumnDescriptors of the current table - * + * @deprecated since 2.0.0 and will be removed in 3.0.0. * @see #getFamilies() + * @see HBASE-18008 */ @Deprecated @Override @@ -653,7 +656,10 @@ public HColumnDescriptor[] getColumnFamilies() { * @param column Column family name * @return Column descriptor for the passed family name or the family on * passed in column. - * @deprecated Use {@link #getColumnFamily(byte[])}. + * @deprecated since 2.0.0 and will be removed in 3.0.0. Use {@link #getColumnFamily(byte[])} + * instead. + * @see #getColumnFamily(byte[]) + * @see HBASE-18008 */ @Deprecated public HColumnDescriptor getFamily(final byte[] column) { @@ -776,12 +782,20 @@ public void removeCoprocessor(String className) { public static final HTableDescriptor NAMESPACE_TABLEDESC = new HTableDescriptor(TableDescriptorBuilder.NAMESPACE_TABLEDESC); + /** + * @deprecated since 0.94.1 + * @see HBASE-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) { @@ -789,6 +803,10 @@ public HTableDescriptor setOwnerString(String ownerString) { return this; } + /** + * @deprecated since 0.94.1 + * @see HBASE-6188 + */ @Override @Deprecated public String getOwnerString() { 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 d4aff047a3c1..5e57799c9946 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 Scan(byte[] startRow, Filter filter) { * 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 Scan(byte[] startRow) { * 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 Scan setTimestamp(long timestamp) { * @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 Scan withStartRow(byte[] startRow, boolean inclusive) { * @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 @@ private byte[] calculateTheClosestNextRowKeyForPrefix(byte[] rowKeyPrefix) { /** * 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 Scan setMaxVersions() { * 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 boolean isRaw() { * 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 Scan setSmall(boolean small) { /** * 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 db62c431f593..0b6f196d615a 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 SnapshotDescription(String name) { } /** - * @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 SnapshotDescription(String name, TableName table) { } /** - * @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 SnapshotDescription(String name, TableName table, SnapshotType type) { } /** - * @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 SnapshotDescription(String name, TableName table, SnapshotType type, Stri } /** - * @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 String getName() { } /** - * @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 9456fd4dc473..beef8986f9f5 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 @@ -190,6 +190,10 @@ default Collection getCoprocessors() { */ 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 02901ac61734..af833b2fd618 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 @@ -431,12 +431,20 @@ public TableDescriptorBuilder setNormalizationEnabled(final boolean isEnable) { 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); @@ -1393,17 +1401,29 @@ public void removeCoprocessor(String className) { } } + /** + * @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 4cde2bfcdeef..ed119494cce2 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 @@ * 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 02c36ab45260..85c038fcf6eb 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 HBaseConfiguration() { /** * 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 949e905a69c0..d810c4ae9aa1 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 @@ 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 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 faaab6f86c37..3337c1d03dd4 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 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 2.0.0 and will be removed in 3.0.0. Use {@link #getLength()} instead. + * @see #getLength() + * @see HBASE-11862 */ @Deprecated public int getSize() { @@ -1370,7 +1372,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 HBASE-6919 */ @Deprecated public static long readVLong(final byte [] buffer, final int offset) @@ -2003,7 +2007,10 @@ public static byte[][] toBinaryByteArrays(final String[] t) { * 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, @@ -2061,7 +2068,10 @@ else if (cmp < 0) * 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 d646f4592a93..2d97405c0aa6 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 @@ /** * 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 ed619fd7ff21..fcf6f552b7ac 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 @@ protected static class TableRecordWriter implements RecordWriterHBASE-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 e744967fa361..6c69651d0a43 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 Cell create(byte[] row, int roffset, int rlength, byte[] family, int foff * @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 6bfaef7b508a..dc293568769a 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 TableInfo(TableDescriptor tableDesctiptor, RegionLocator regionLocator) { /** * 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 1d6308adc664..df07780737a3 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 ce9f93ae2aa4..7098e248882d 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 static void initCredentials(Job job) throws IOException { * @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 static void addDependencyJars(Job job) throws IOException { * 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-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 4e3281101b27..9cbf748f90db 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 @@ * 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 4e63f430e226..dbd393db9884 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 67aad2680971..22a9da548d6f 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 @@ @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 0a4efb033a67..5c76c0b44b3c 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 @@ void readCompleted() { } /** - * @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 HFileScanner getScanner(boolean cacheBlocks, boolean pread) { } /** - * @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 HFileScanner getScanner(boolean cacheBlocks, boolean pread) { * @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/wal/WALEdit.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALEdit.java index 3d90a45f7442..d79ff8a6dabc 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 WALEdit() { } /** - * @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 WALEdit(boolean isReplay) { } /** - * @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 706a75f287db..7d296fa0e5ce 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 @@ /** * 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 78c7973b3033..4ff31274c05a 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 HBaseTestingUtility(@Nullable Configuration conf) { } /** - * @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 static HBaseTestingUtility createLocalHTU() { } /** - * @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) { @@ -1752,6 +1759,12 @@ public void deleteTableIfAny(TableName tableName) throws IOException { 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) { @@ -1763,6 +1776,10 @@ public HTableDescriptor createTableDescriptor(final String name, * 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) { @@ -1864,8 +1881,11 @@ public HRegion createLocalHRegion(RegionInfo info, TableDescriptor desc, WAL wal * @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,