hbase-common/src/main/java/org/apache/hadoop/hbase/RawCellBuilder.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase;
  19
  20 import java.util.List;
  21
  22 import org.apache.yetus.audience.InterfaceAudience;
  23
  24 /**
  25  * Allows creating a cell with {@link Tag}
  26  * An instance of this type can be acquired by using RegionCoprocessorEnvironment#getCellBuilder
  27  * (for prod code) and {@link RawCellBuilderFactory} (for unit tests).
  28  */
  29 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
  30 public interface RawCellBuilder extends CellBuilder {
  31   @Override
  32   RawCellBuilder setRow(final byte[] row);
  33   @Override
  34   RawCellBuilder setRow(final byte[] row, final int rOffset, final int rLength);
  35
  36   @Override
  37   RawCellBuilder setFamily(final byte[] family);
  38   @Override
  39   RawCellBuilder setFamily(final byte[] family, final int fOffset, final int fLength);
  40
  41   @Override
  42   RawCellBuilder setQualifier(final byte[] qualifier);
  43   @Override
  44   RawCellBuilder setQualifier(final byte[] qualifier, final int qOffset, final int qLength);
  45
  46   @Override
  47   RawCellBuilder setTimestamp(final long timestamp);
  48
  49   @Override
  50   RawCellBuilder setType(final Cell.Type type);
  51
  52   @Override
  53   RawCellBuilder setValue(final byte[] value);
  54   @Override
  55   RawCellBuilder setValue(final byte[] value, final int vOffset, final int vLength);
  56
  57   RawCellBuilder setTags(final List<Tag> tags);
  58
  59   @Override
  60   RawCell build();
  61
  62   @Override
  63   RawCellBuilder clear();
  64 }