hbase-common/src/main/java/org/apache/hadoop/hbase/CellBuilder.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
  19 package org.apache.hadoop.hbase;
  20
  21 import org.apache.yetus.audience.InterfaceAudience;
  22
  23 /**
  24  * Use {@link CellBuilderFactory} to get CellBuilder instance.
  25  */
  26 @InterfaceAudience.Public
  27 public interface CellBuilder {
  28
  29   CellBuilder setRow(final byte[] row);
  30   CellBuilder setRow(final byte[] row, final int rOffset, final int rLength);
  31
  32   CellBuilder setFamily(final byte[] family);
  33   CellBuilder setFamily(final byte[] family, final int fOffset, final int fLength);
  34
  35   CellBuilder setQualifier(final byte[] qualifier);
  36   CellBuilder setQualifier(final byte[] qualifier, final int qOffset, final int qLength);
  37
  38   CellBuilder setTimestamp(final long timestamp);
  39
  40   CellBuilder setType(final Cell.Type type);
  41
  42   CellBuilder setValue(final byte[] value);
  43   CellBuilder setValue(final byte[] value, final int vOffset, final int vLength);
  44
  45   Cell build();
  46
  47   /**
  48    * Remove all internal elements from builder.
  49    * @return this
  50    */
  51   CellBuilder clear();
  52 }