HBASE-19773 Documenting how to get instance of type RawCellBuilder
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/09ae5abb Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/09ae5abb Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/09ae5abb Branch: refs/heads/HBASE-19064 Commit: 09ae5abbe78e721a207a64733f2925fa6ce820f0 Parents: e0eea94 Author: Apekshit Sharma <a...@apache.org> Authored: Thu Jan 11 13:12:17 2018 -0800 Committer: Apekshit Sharma <a...@apache.org> Committed: Thu Jan 11 13:17:03 2018 -0800 ---------------------------------------------------------------------- .../src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java | 1 + .../main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java | 2 ++ 2 files changed, 3 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/09ae5abb/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java ---------------------------------------------------------------------- diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java index 53920f6..9e89307 100644 --- a/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java @@ -23,6 +23,7 @@ import org.apache.yetus.audience.InterfaceAudience; /** * Allows creating a cell with {@link Tag} + * An instance of this type can be acquired using RegionCoprocessorEnvironment#getCellBuilder. */ @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC) public interface RawCellBuilder extends CellBuilder { http://git-wip-us.apache.org/repos/asf/hbase/blob/09ae5abb/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java ---------------------------------------------------------------------- diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java index 8d0c1ab..0f61ee8 100644 --- a/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilderFactory.java @@ -23,6 +23,8 @@ import org.apache.yetus.audience.InterfaceAudience; /** * Factory for creating cells for CPs. It does deep_copy {@link CellBuilderType#DEEP_COPY} while * creating cells. + * This is private because coprocessors should get an instance of type {@link RawCellBuilder} + * using RegionCoprocessorEnvironment#getCellBuilder. */ @InterfaceAudience.Private public final class RawCellBuilderFactory {
