hbase-common/src/main/java/org/apache/hadoop/hbase/codec/BaseEncoder.java

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