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 java.io.IOException;
21 import java.io.OutputStream;
22
23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
24
25 /**
26 * This marks a Cell as streamable to a given OutputStream.
27 */
28 @InterfaceAudience.Private
29 public interface Streamable {
30
31 /**
32 * Write this cell to an OutputStream.
33 * @param out Stream to which cell has to be written
34 * @return how many bytes are written.
35 * @throws IOException
36 */
37 int write(OutputStream out) throws IOException;
38
39 /**
40 * Write this cell to an OutputStream.
41 * @param out Stream to which cell has to be written
42 * @param withTags Whether to write tags.
43 * @return how many bytes are written.
44 * @throws IOException
45 */
46 int write(OutputStream out, boolean withTags) throws IOException;
47 }