001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.codec;
019
020import java.io.IOException;
021import java.io.OutputStream;
022
023import org.apache.hadoop.hbase.Cell;
024import org.apache.hadoop.hbase.HBaseInterfaceAudience;
025import org.apache.yetus.audience.InterfaceAudience;
026
027
028/**
029 * TODO javadoc
030 */
031
032@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})
033public abstract class BaseEncoder implements Codec.Encoder {
034  protected final OutputStream out;
035  // This encoder is 'done' once flush has been called.
036  protected boolean flushed = false;
037
038  public BaseEncoder(final OutputStream out) {
039    this.out = out;
040  }
041
042  protected OutputStream getOuputStream() {
043    return out;
044  }
045
046  @Override
047  public abstract void write(Cell cell) throws IOException;
048
049  protected void checkFlushed() throws CodecException {
050    if (this.flushed) throw new CodecException("Flushed; done");
051  }
052
053  @Override
054  public void flush() throws IOException {
055    if (this.flushed) return;
056    this.flushed = true;
057    this.out.flush();
058  }
059}