org.apache.hadoop.hbase.regionserver.CellSink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hbase-server Show documentation

Server functionality for HBase

There is a newer version: 3.0.0-beta-1

/*
 * 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.regionserver;

import java.io.IOException;
import java.util.List;
import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.util.BloomFilterWriter;
import org.apache.yetus.audience.InterfaceAudience;

/**
 * A sink of cells that allows appending cells to the Writers that implement it.
 * {@link org.apache.hadoop.hbase.io.hfile.HFile.Writer}, {@link StoreFileWriter},
 * {@link AbstractMultiFileWriter}, {@link BloomFilterWriter} are some implementors of this.
 */
@InterfaceAudience.Private
public interface CellSink {
  /**
   * Append the given cell
   * @param cell the cell to be added
   */
  void append(Cell cell) throws IOException;

  /**
   * Append the given (possibly partial) list of cells of a row
   * @param cellList the cell list to be added
   */
  default void appendAll(List cellList) throws IOException {
    for (Cell cell : cellList) {
      append(cell);
    }
  }
}