Repository: hbase Updated Branches: refs/heads/branch-1 39b7a5558 -> 566dfda5b
HBASE-13466 Document deprecations in 1.x - Part 1 (Lars Francke) Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/566dfda5 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/566dfda5 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/566dfda5 Branch: refs/heads/branch-1 Commit: 566dfda5b79f0d0035c58b285cfab2fc54f3c8fb Parents: 39b7a55 Author: Nick Dimiduk <[email protected]> Authored: Sun Apr 26 13:11:22 2015 -0700 Committer: Nick Dimiduk <[email protected]> Committed: Sun Apr 26 13:11:35 2015 -0700 ---------------------------------------------------------------------- .../org/apache/hadoop/hbase/ClusterStatus.java | 11 +++- .../apache/hadoop/hbase/HColumnDescriptor.java | 69 ++++++++++++++++---- .../org/apache/hadoop/hbase/HRegionInfo.java | 20 ++++-- .../apache/hadoop/hbase/HTableDescriptor.java | 7 +- .../hadoop/hbase/client/ClientScanner.java | 4 +- .../org/apache/hadoop/hbase/client/HTable.java | 5 +- .../hadoop/hbase/client/HTableInterface.java | 5 +- .../hbase/mapreduce/LoadIncrementalHFiles.java | 5 +- .../hadoop/hbase/mapreduce/TableSplit.java | 10 ++- 9 files changed, 107 insertions(+), 29 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java index 592a01b..c8caa96 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java @@ -87,7 +87,10 @@ public class ClusterStatus extends VersionedWritable { /** * Constructor, for Writable - * @deprecated Used by Writables and Writables are going away. + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-6038";>HBASE-6038</a>). + * This will be removed in HBase 2.0.0. + * Used by Writables and Writables are going away. */ @Deprecated public ClusterStatus() { @@ -221,8 +224,12 @@ public class ClusterStatus extends VersionedWritable { * Returns detailed region server information: A list of * {@link ServerName}. * @return region server information - * @deprecated Use {@link #getServers()} + * @deprecated As of release 0.92 + * (<a href="https://issues.apache.org/jira/browse/HBASE-1502";>HBASE-1502</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #getServers()}. */ + @Deprecated public Collection<ServerName> getServerInfo() { return getServers(); } http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java ---------------------------------------------------------------------- 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 401e0da..596a533 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 @@ -285,8 +285,11 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> private int cachedMaxVersions = UNINITIALIZED; /** - * Default constructor. Must be present for Writable. - * @deprecated Used by Writables and Writables are going away. + * Default constructor. + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-5453";>HBASE-5453</a>). + * This will be made private in HBase 2.0.0. + * Used by Writables and Writables are going away. */ @Deprecated // Make this private rather than remove after deprecation period elapses. Its needed by pb @@ -356,7 +359,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> * other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains * a <code>:</code> * @throws IllegalArgumentException if the number of versions is <= 0 - * @deprecated use {@link #HColumnDescriptor(String)} and setters + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-";>HBASE-</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #HColumnDescriptor(String)} and setters. */ @Deprecated public HColumnDescriptor(final byte [] familyName, final int maxVersions, @@ -388,7 +394,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> * other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains * a <code>:</code> * @throws IllegalArgumentException if the number of versions is <= 0 - * @deprecated use {@link #HColumnDescriptor(String)} and setters + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-";>HBASE-</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #HColumnDescriptor(String)} and setters. */ @Deprecated public HColumnDescriptor(final byte [] familyName, final int maxVersions, @@ -428,7 +437,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> * other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains * a <code>:</code> * @throws IllegalArgumentException if the number of versions is <= 0 - * @deprecated use {@link #HColumnDescriptor(String)} and setters + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-";>HBASE-</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #HColumnDescriptor(String)} and setters. */ @Deprecated public HColumnDescriptor(final byte[] familyName, final int minVersions, @@ -670,7 +682,12 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> return setValue(COMPRESSION, type.getName().toUpperCase()); } - /** @return data block encoding algorithm used on disk */ + /** + * @return data block encoding algorithm used on disk + * @deprecated As of release 0.98 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9870";>HBASE-9870</a>). + * This will be removed in HBase 2.0.0. See {@link #getDataBlockEncoding()}} + */ @Deprecated public DataBlockEncoding getDataBlockEncodingOnDisk() { return getDataBlockEncoding(); @@ -680,6 +697,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> * This method does nothing now. Flag ENCODE_ON_DISK is not used * any more. Data blocks have the same encoding in cache as on disk. * @return this (for chained invocation) + * @deprecated As of release 0.98 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9870";>HBASE-9870</a>). + * This will be removed in HBase 2.0.0. This method does nothing now. */ @Deprecated public HColumnDescriptor setEncodeOnDisk(boolean encodeOnDisk) { @@ -727,7 +747,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return Whether KV tags should be compressed along with DataBlockEncoding. When no * DataBlockEncoding is been used, this is having no effect. - * @deprecated Use {@link #isCompressTags()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. Use {@link #isCompressTags()} instead. */ @Deprecated public boolean shouldCompressTags() { @@ -805,7 +827,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> * @param keepDeletedCells True if deleted rows should not be collected * immediately. * @return this (for chained invocation) - * @deprecated use {@link #setKeepDeletedCells(KeepDeletedCells)} + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-12363";>HBASE-12363</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #setKeepDeletedCells(KeepDeletedCells)}. */ @Deprecated public HColumnDescriptor setKeepDeletedCells(boolean keepDeletedCells) { @@ -915,7 +940,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should cache data blocks on write - * @deprecated Use {@link #isCacheDataOnWrite()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. Use {@link #isCacheDataOnWrite()}} instead. */ @Deprecated public boolean shouldCacheDataOnWrite() { @@ -940,7 +967,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should cache data blocks in the L1 cache (if block cache deploy * has more than one tier; e.g. we are using CombinedBlockCache). - * @deprecated Use {@link #isCacheDataInL1()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. Use {@link #isCacheDataInL1()}} instead. */ @Deprecated public boolean shouldCacheDataInL1() { @@ -972,7 +1001,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should cache index blocks on write - * @deprecated Use {@link #isCacheIndexesOnWrite()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #isCacheIndexesOnWrite()} instead. */ @Deprecated public boolean shouldCacheIndexesOnWrite() { @@ -996,7 +1028,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should cache bloomfilter blocks on write - * @deprecated Use {@link #isCacheBloomsOnWrite()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #isCacheBloomsOnWrite()}} instead. */ @Deprecated public boolean shouldCacheBloomsOnWrite() { @@ -1021,7 +1056,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should evict cached blocks from the blockcache on * close - * @deprecated {@link #isEvictBlocksOnClose()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #isEvictBlocksOnClose()}} instead. */ @Deprecated public boolean shouldEvictBlocksOnClose() { @@ -1046,7 +1084,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor> /** * @return true if we should prefetch blocks into the blockcache on open - * @deprecated Use {@link #isPrefetchBlocksOnOpen()} instead + * @deprecated As of release 1.0.0 + * (<a href="https://issues.apache.org/jira/browse/HBASE-10870";>HBASE-10870</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #isPrefetchBlocksOnOpen()}}} instead. */ @Deprecated public boolean shouldPrefetchBlocksOnOpen() { http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionInfo.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionInfo.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionInfo.java index a6df950..3c7b2ce 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionInfo.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionInfo.java @@ -86,7 +86,8 @@ public class HRegionInfo implements Comparable<HRegionInfo> { * the hbase:meta table. * * Pre-0.92: - * HRI.VERSION == 0 and HConstants.META_VERSION does not exist (is not stored at hbase:meta table) + * HRI.VERSION == 0 and HConstants.META_VERSION does not exist + * (is not stored at hbase:meta table) * HRegionInfo had an HTableDescriptor reference inside it. * HRegionInfo is serialized as Writable to hbase:meta table. * For 0.92.x and 0.94.x: @@ -257,7 +258,10 @@ public class HRegionInfo implements Comparable<HRegionInfo> { } /** Default constructor - creates empty object - * @deprecated Used by Writables and Writables are going away. + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-5453";>HBASE-5453</a>). + * This will be removed in HBase 2.0.0. + * Used by Writables and Writables are going away. */ @Deprecated public HRegionInfo() { @@ -509,7 +513,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> { * Gets the table name from the specified region name. * @param regionName * @return Table name. - * @deprecated Since 0.96.0; use #getTable(byte[]) + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. Use {@link #getTable(byte[])}. */ @Deprecated public static byte [] getTableName(byte[] regionName) { @@ -676,7 +682,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> { /** * Get current table name of the region * @return byte array of table name - * @deprecated Since 0.96.0; use #getTable() + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. Use {@link #getTable()}. */ @Deprecated public byte [] getTableName() { @@ -1264,7 +1272,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> { if (in.markSupported()) { //read it with mark() in.mark(pblen); } - int read = in.read(pbuf); //assumption: if Writable serialization, it should be longer than pblen. + + //assumption: if Writable serialization, it should be longer than pblen. + int read = in.read(pbuf); if (read != pblen) throw new IOException("read=" + read + ", wanted=" + pblen); if (ProtobufUtil.isPBMagicPrefix(pbuf)) { return convert(HBaseProtos.RegionInfo.parseDelimitedFrom(in)); http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/HTableDescriptor.java ---------------------------------------------------------------------- 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 00578de..947ac91 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 @@ -309,7 +309,10 @@ public class HTableDescriptor implements WritableComparable<HTableDescriptor> { /** * Default constructor which constructs an empty object. * For deserializing an HTableDescriptor instance only. - * @deprecated Used by Writables and Writables are going away. + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-5453";>HBASE-5453</a>). + * This will be removed in HBase 2.0.0. + * Used by Writables and Writables are going away. */ @Deprecated public HTableDescriptor() { @@ -1107,7 +1110,7 @@ public class HTableDescriptor implements WritableComparable<HTableDescriptor> { * This compares the content of the two descriptors and not the reference. * * @return 0 if the contents of the descriptors are exactly matching, - * 1 if there is a mismatch in the contents + * 1 if there is a mismatch in the contents */ @Override public int compareTo(final HTableDescriptor other) { http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientScanner.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientScanner.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientScanner.java index 8dce8d8..33afce4 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientScanner.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientScanner.java @@ -166,7 +166,9 @@ public class ClientScanner extends AbstractClientScanner { /** * @return Table name - * @deprecated Since 0.96.0; use {@link #getTable()} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. Use {@link #getTable()}. */ @Deprecated protected byte [] getTableName() { http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTable.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTable.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTable.java index 5b0e685..eedd7f6 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTable.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTable.java @@ -1138,7 +1138,10 @@ public class HTable implements HTableInterface { } /** - * @deprecated Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}. */ @Deprecated @Override http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTableInterface.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTableInterface.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTableInterface.java index 1f4d99a..5823f69 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTableInterface.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HTableInterface.java @@ -46,7 +46,10 @@ public interface HTableInterface extends Table { byte[] getTableName(); /** - * @deprecated Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}. */ @Deprecated long incrementColumnValue(final byte [] row, final byte [] family, http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/LoadIncrementalHFiles.java ---------------------------------------------------------------------- diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/LoadIncrementalHFiles.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/LoadIncrementalHFiles.java index 3032251..827699b 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/LoadIncrementalHFiles.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/LoadIncrementalHFiles.java @@ -682,7 +682,10 @@ public class LoadIncrementalHFiles extends Configured implements Tool { } /** - * @deprecated Use {@link #tryAtomicRegionLoad(Connection, TableName, byte[], Collection)} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. + * Use {@link #tryAtomicRegionLoad(Connection, TableName, byte[], Collection)}. */ @Deprecated protected List<LoadQueueItem> tryAtomicRegionLoad(final HConnection conn, http://git-wip-us.apache.org/repos/asf/hbase/blob/566dfda5/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableSplit.java ---------------------------------------------------------------------- diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableSplit.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableSplit.java index d30c948..090b1a2 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableSplit.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableSplit.java @@ -91,7 +91,10 @@ implements Writable, Comparable<TableSplit> { } /** - * @deprecated Since 0.96.0; use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. + * Use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}. */ @Deprecated public TableSplit(final byte [] tableName, Scan scan, byte [] startRow, byte [] endRow, @@ -139,7 +142,10 @@ implements Writable, Comparable<TableSplit> { } /** - * @deprecated Since 0.96.0; use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)} + * @deprecated As of release 0.96 + * (<a href="https://issues.apache.org/jira/browse/HBASE-9508";>HBASE-9508</a>). + * This will be removed in HBase 2.0.0. + * Use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}. */ @Deprecated public TableSplit(final byte [] tableName, byte[] startRow, byte[] endRow,
