org.apache.hadoop.hbase.CellScannable Maven / Gradle / Ivy

Go to download

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

Common 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;

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

/**
 * Implementer can return a CellScanner over its Cell content.
 * Class name is ugly but mimicing java.util.Iterable only we are about the dumber
 * CellScanner rather than say Iterator<Cell>.  See CellScanner class comment for why we go
 * dumber than java.util.Iterator.
 */
@InterfaceAudience.Private
public interface CellScannable {
  /**
   * @return A CellScanner over the contained {@link Cell}s
   */
  CellScanner cellScanner();
}