com.facebook.hive.orc.PositionedOutputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hive-dwrf Show documentation

DWRF file format for Hive

There is a newer version: 0.18.9

//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.facebook.hive.orc;

import java.io.IOException;
import java.io.OutputStream;

abstract class PositionedOutputStream extends OutputStream {

  //if enabled the stream will be suppressed when writing stripe
  protected boolean suppress;

  /**
   * Record the current position to the recorder.
   * @param recorder the object that receives the position
   * @throws IOException
   */
  abstract void getPosition(PositionRecorder recorder) throws IOException;

  /**
   * Get the memory size currently allocated as buffer associated with this
   * stream.
   * @return the number of bytes used by buffers.
   */
  abstract long getBufferSize();

  abstract void flush(boolean reuseBuffer) throws IOException;

  /**
   * Set suppress flag
   */
  public void suppress() {
    suppress = true;
  }

  /**
   * Unset suppress flag
   */
  public void unsuppress() {
    suppress = false;
  }
}