/*
 *  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 org.apache.parquet.io;

import java.io.IOException;

/**
 * {@code OutputFile} is an interface with the methods needed by Parquet to write
 * data files using {@link PositionOutputStream} instances.
 */
public interface OutputFile {

  /**
   * Opens a new {@link PositionOutputStream} for the data file to create.
   *
   * @return a new {@link PositionOutputStream} to write the file
   * @throws IOException if the stream cannot be opened
   */
  PositionOutputStream create(long blockSizeHint) throws IOException;

  /**
   * Opens a new {@link PositionOutputStream} for the data file to create or overwrite.
   *
   * @return a new {@link PositionOutputStream} to write the file
   * @throws IOException if the stream cannot be opened
   */
  PositionOutputStream createOrOverwrite(long blockSizeHint) throws IOException;

  /**
   * @return a flag indicating if block size is supported.
   */
  boolean supportsBlockSize();

  /**
   * @return the default block size.
   */
  long defaultBlockSize();

  /**
   * @return the path of the file, as a {@link String}.
   */
  default String getPath() {
    return null;
  }
}
