HBASE-14052 Mark a few methods in CellUtil audience private since only make sense internally to hbase

This commit is contained in:
stack 2015-07-10 10:43:27 -07:00
parent bff911a8e8
commit 66082c7224
2 changed files with 32 additions and 0 deletions

View File

@ -167,7 +167,10 @@ public class Put extends Mutation implements HeapSize, Comparable<Row> {
/** /**
* This expects that the underlying arrays won't change. It's intended * This expects that the underlying arrays won't change. It's intended
* for usage internal HBase to and for advanced client applications. * for usage internal HBase to and for advanced client applications.
* <p>Marked as audience Private as of 1.2.0. {@link Tag} is an internal implementation detail
* that should not be exposed publicly.
*/ */
@InterfaceAudience.Private
public Put addImmutable(byte[] family, byte [] qualifier, byte [] value, Tag[] tag) { public Put addImmutable(byte[] family, byte [] qualifier, byte [] value, Tag[] tag) {
return addImmutable(family, qualifier, this.ts, value, tag); return addImmutable(family, qualifier, this.ts, value, tag);
} }
@ -226,7 +229,10 @@ public class Put extends Mutation implements HeapSize, Comparable<Row> {
/** /**
* This expects that the underlying arrays won't change. It's intended * This expects that the underlying arrays won't change. It's intended
* for usage internal HBase to and for advanced client applications. * for usage internal HBase to and for advanced client applications.
* <p>Marked as audience Private as of 1.2.0. {@link Tag} is an internal implementation detail
* that should not be exposed publicly.
*/ */
@InterfaceAudience.Private
public Put addImmutable(byte[] family, byte[] qualifier, long ts, byte[] value, Tag[] tag) { public Put addImmutable(byte[] family, byte[] qualifier, long ts, byte[] value, Tag[] tag) {
List<Cell> list = getCellList(family); List<Cell> list = getCellList(family);
KeyValue kv = createPutKeyValue(family, qualifier, ts, value, tag); KeyValue kv = createPutKeyValue(family, qualifier, ts, value, tag);
@ -238,7 +244,10 @@ public class Put extends Mutation implements HeapSize, Comparable<Row> {
/** /**
* This expects that the underlying arrays won't change. It's intended * This expects that the underlying arrays won't change. It's intended
* for usage internal HBase to and for advanced client applications. * for usage internal HBase to and for advanced client applications.
* <p>Marked as audience Private as of 1.2.0. {@link Tag} is an internal implementation detail
* that should not be exposed publicly.
*/ */
@InterfaceAudience.Private
public Put addImmutable(byte[] family, ByteBuffer qualifier, long ts, ByteBuffer value, public Put addImmutable(byte[] family, ByteBuffer qualifier, long ts, ByteBuffer value,
Tag[] tag) { Tag[] tag) {
if (ts < 0) { if (ts < 0) {

View File

@ -39,6 +39,8 @@ import org.apache.hadoop.hbase.util.Bytes;
/** /**
* Utility methods helpful slinging {@link Cell} instances. * Utility methods helpful slinging {@link Cell} instances.
* Some methods below are for internal use only and are marked InterfaceAudience.Private at the
* method level.
*/ */
@InterfaceAudience.Public @InterfaceAudience.Public
@InterfaceStability.Evolving @InterfaceStability.Evolving
@ -236,6 +238,12 @@ public final class CellUtil {
HConstants.EMPTY_BYTE_ARRAY, 0, HConstants.EMPTY_BYTE_ARRAY.length); HConstants.EMPTY_BYTE_ARRAY, 0, HConstants.EMPTY_BYTE_ARRAY.length);
} }
/**
* Marked as audience Private as of 1.2.0.
* Creating a Cell with a memstoreTS/mvcc is an internal implementation detail not for
* public use.
*/
@InterfaceAudience.Private
public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier, public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier,
final long timestamp, final byte type, final byte[] value, final long memstoreTS) { final long timestamp, final byte type, final byte[] value, final long memstoreTS) {
KeyValue keyValue = new KeyValue(row, family, qualifier, timestamp, KeyValue keyValue = new KeyValue(row, family, qualifier, timestamp,
@ -244,6 +252,12 @@ public final class CellUtil {
return keyValue; return keyValue;
} }
/**
* Marked as audience Private as of 1.2.0.
* Creating a Cell with tags and a memstoreTS/mvcc is an internal implementation detail not for
* public use.
*/
@InterfaceAudience.Private
public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier, public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier,
final long timestamp, final byte type, final byte[] value, byte[] tags, final long timestamp, final byte type, final byte[] value, byte[] tags,
final long memstoreTS) { final long memstoreTS) {
@ -253,6 +267,12 @@ public final class CellUtil {
return keyValue; return keyValue;
} }
/**
* Marked as audience Private as of 1.2.0.
* Creating a Cell with tags is an internal implementation detail not for
* public use.
*/
@InterfaceAudience.Private
public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier, public static Cell createCell(final byte[] row, final byte[] family, final byte[] qualifier,
final long timestamp, Type type, final byte[] value, byte[] tags) { final long timestamp, Type type, final byte[] value, byte[] tags) {
KeyValue keyValue = new KeyValue(row, family, qualifier, timestamp, type, value, tags); KeyValue keyValue = new KeyValue(row, family, qualifier, timestamp, type, value, tags);
@ -766,10 +786,13 @@ public final class CellUtil {
/** /**
* Sets the given seqId to the cell. * Sets the given seqId to the cell.
* Marked as audience Private as of 1.2.0.
* Setting a Cell sequenceid is an internal implementation detail not for general public use.
* @param cell * @param cell
* @param seqId * @param seqId
* @throws IOException when the passed cell is not of type {@link SettableSequenceId} * @throws IOException when the passed cell is not of type {@link SettableSequenceId}
*/ */
@InterfaceAudience.Private
public static void setSequenceId(Cell cell, long seqId) throws IOException { public static void setSequenceId(Cell cell, long seqId) throws IOException {
if (cell instanceof SettableSequenceId) { if (cell instanceof SettableSequenceId) {
((SettableSequenceId) cell).setSequenceId(seqId); ((SettableSequenceId) cell).setSequenceId(seqId);