001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.hbase;
020
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Use {@link CellBuilderFactory} to get CellBuilder instance.
025 */
026@InterfaceAudience.Public
027public interface CellBuilder {
028
029  CellBuilder setRow(final byte[] row);
030  CellBuilder setRow(final byte[] row, final int rOffset, final int rLength);
031
032  CellBuilder setFamily(final byte[] family);
033  CellBuilder setFamily(final byte[] family, final int fOffset, final int fLength);
034
035  CellBuilder setQualifier(final byte[] qualifier);
036  CellBuilder setQualifier(final byte[] qualifier, final int qOffset, final int qLength);
037
038  CellBuilder setTimestamp(final long timestamp);
039
040  CellBuilder setType(final Cell.Type type);
041
042  CellBuilder setValue(final byte[] value);
043  CellBuilder setValue(final byte[] value, final int vOffset, final int vLength);
044
045  Cell build();
046
047  /**
048   * Remove all internal elements from builder.
049   * @return this
050   */
051  CellBuilder clear();
052}