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;
022import org.apache.hadoop.hbase.Cell;
023import org.apache.hadoop.hbase.HBaseInterfaceAudience;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * TODO javadoc
028 */
029
030@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX })
031public abstract class BaseEncoder implements Codec.Encoder {
032  protected final OutputStream out;
033  // This encoder is 'done' once flush has been called.
034  protected boolean flushed = false;
035
036  public BaseEncoder(final OutputStream out) {
037    this.out = out;
038  }
039
040  protected OutputStream getOuputStream() {
041    return out;
042  }
043
044  @Override
045  public abstract void write(Cell cell) throws IOException;
046
047  protected void checkFlushed() throws CodecException {
048    if (this.flushed) throw new CodecException("Flushed; done");
049  }
050
051  @Override
052  public void flush() throws IOException {
053    if (this.flushed) return;
054    this.flushed = true;
055    this.out.flush();
056  }
057}