View Javadoc

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.codec;
19  
20  import java.io.IOException;
21  import java.io.OutputStream;
22  
23  import org.apache.hadoop.classification.InterfaceAudience;
24  import org.apache.hadoop.hbase.Cell;
25  
26  /**
27   * TODO javadoc
28   */
29  
30  @InterfaceAudience.Private
31  public abstract class BaseEncoder implements Codec.Encoder {
32    protected final OutputStream out;
33    // This encoder is 'done' once flush has been called.
34    protected boolean flushed = false;
35  
36    public BaseEncoder(final OutputStream out) {
37      this.out = out;
38    }
39  
40    @Override
41    public abstract void write(Cell cell) throws IOException;
42  
43    protected void checkFlushed() throws CodecException {
44      if (this.flushed) throw new CodecException("Flushed; done");
45    }
46  
47    @Override
48    public void flush() throws IOException {
49      if (this.flushed) return;
50      this.flushed = true;
51      this.out.flush();
52    }
53  }