1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase;
19
20 import org.apache.hadoop.hbase.classification.InterfaceAudience;
21
22 /**
23 * Implementer can return a CellScanner over its Cell content.
24 * Class name is ugly but mimicing java.util.Iterable only we are about the dumber
25 * CellScanner rather than say Iterator<Cell>. See CellScanner class comment for why we go
26 * dumber than java.util.Iterator.
27 */
28 @InterfaceAudience.Private
29 public interface CellScannable {
30 /**
31 * @return A CellScanner over the contained {@link Cell}s
32 */
33 CellScanner cellScanner();
34 }