HBASE-13983 Doc how the oddball HTable methods getStartKey, getEndKey, etc. will be removed in 2.0.0

This commit is contained in:
stack 2015-07-01 13:05:25 -07:00
parent a883bb4e54
commit 93b0b41603
1 changed files with 17 additions and 6 deletions

View File

@ -93,11 +93,19 @@ import com.google.protobuf.ServiceException;
* In the case of reads, some fields used by a Scan are shared among all threads.
*
* <p>HTable is no longer a client API. Use {@link Table} instead. It is marked
* InterfaceAudience.Private indicating that this is an HBase-internal class as defined in
* InterfaceAudience.Private as of hbase-1.0.0 indicating that this is an
* HBase-internal class as defined in
* <a href="https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/InterfaceClassification.html">Hadoop
* Interface Classification</a>
* There are no guarantees for backwards source / binary compatibility and methods or class can
* Interface Classification</a>. There are no guarantees for backwards
* source / binary compatibility and methods or the class can
* change or go away without deprecation.
* <p>Near all methods of this * class made it out to the new {@link Table}
* Interface or were * instantiations of methods defined in {@link HTableInterface}.
* A few did not. Namely, the {@link #getStartEndKeys}, {@link #getEndKeys},
* and {@link #getStartKeys} methods. These three methods are available
* in {@link RegionLocator} as of 1.0.0 but were NOT marked as
* deprecated when we released 1.0.0. In spite of this oversight on our
* part, these methods will be removed in 2.0.0.
*
* @see Table
* @see Admin
@ -600,7 +608,8 @@ public class HTable implements HTableInterface, RegionLocator {
}
/**
* @deprecated Use {@link RegionLocator#getStartEndKeys()} instead;
* To be removed in 2.0.0.
* @deprecated Since 1.1.0. Use {@link RegionLocator#getStartEndKeys()} instead
*/
@Override
@Deprecated
@ -609,7 +618,8 @@ public class HTable implements HTableInterface, RegionLocator {
}
/**
* @deprecated Use {@link RegionLocator#getEndKeys()} instead;
* To be removed in 2.0.0.
* @deprecated Since 1.1.0. Use {@link RegionLocator#getEndKeys()} instead;
*/
@Override
@Deprecated
@ -618,7 +628,8 @@ public class HTable implements HTableInterface, RegionLocator {
}
/**
* @deprecated Use {@link RegionLocator#getStartEndKeys()} instead;
* To be removed in 2.0.0.
* @deprecated Since 1.1.0. Use {@link RegionLocator#getStartEndKeys()} instead;
*/
@Override
@Deprecated