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 */
018package org.apache.hadoop.hbase.regionserver;
019
020import java.io.IOException;
021import java.util.List;
022import org.apache.hadoop.hbase.ExtendedCell;
023import org.apache.hadoop.hbase.util.BloomFilterWriter;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * A sink of cells that allows appending cells to the Writers that implement it.
028 * {@link org.apache.hadoop.hbase.io.hfile.HFile.Writer}, {@link StoreFileWriter},
029 * {@link AbstractMultiFileWriter}, {@link BloomFilterWriter} are some implementors of this.
030 */
031@InterfaceAudience.Private
032public interface CellSink {
033  /**
034   * Append the given cell
035   * @param cell the cell to be added
036   */
037  void append(ExtendedCell cell) throws IOException;
038
039  /**
040   * Append the given (possibly partial) list of cells of a row
041   * @param cellList the cell list to be added
042   */
043  default void appendAll(List<ExtendedCell> cellList) throws IOException {
044    for (ExtendedCell cell : cellList) {
045      append(cell);
046    }
047  }
048}