/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase;

import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;

import org.apache.hadoop.hbase.classification.InterfaceAudience;
import org.apache.hadoop.hbase.io.HeapSize;

/**
 * Extension to {@link Cell} with server side required functions. Server side Cell implementations
 * must implement this.
 * @see SettableSequenceId
 * @see SettableTimestamp
 */
@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
public interface ExtendedCell extends Cell, SettableSequenceId, SettableTimestamp, HeapSize,
    Cloneable {

  public static int CELL_NOT_BASED_ON_CHUNK = -1;
  /**
   * Write this cell to an OutputStream in a {@link KeyValue} format.
   * <br> KeyValue format <br>
   * <code><4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength>
   * <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier>
   * <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength>
   * <tags></code>
   * @param out Stream to which cell has to be written
   * @param withTags Whether to write tags.
   * @return how many bytes are written.
   * @throws IOException
   */
  // TODO remove the boolean param once HBASE-16706 is done.
  int write(OutputStream out, boolean withTags) throws IOException;

  /**
   * @param withTags Whether to write tags.
   * @return Bytes count required to serialize this Cell in a {@link KeyValue} format.
   * <br> KeyValue format <br>
   * <code><4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength>
   * <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier>
   * <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength>
   * <tags></code>
   */
  // TODO remove the boolean param once HBASE-16706 is done.
  int getSerializedSize(boolean withTags);

  /**
   * Write this Cell into the given buf's offset in a {@link KeyValue} format.
   * @param buf The buffer where to write the Cell.
   * @param offset The offset within buffer, to write the Cell.
   */
  void write(ByteBuffer buf, int offset);

  /**
   * Does a deep copy of the contents to a new memory area and returns it as a new cell.
   * @return The deep cloned cell
   */
  Cell deepClone();

  /**
   * Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized
   * chunks as in case of MemstoreLAB
   * @return the chunk id if the cell is backed by fixed sized Chunks, else return -1
   */
  default int getChunkId() {
    return CELL_NOT_BASED_ON_CHUNK;
  }
}