com.helger.commons.io.IHasOutputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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.helger.commons.io;

import java.io.OutputStream;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.io.stream.StreamHelper;

/**
 * A callback interface to retrieve {@link OutputStream} objects.
 *
 * @author Philip Helger
 */
public interface IHasOutputStream
{
  /**
   * Get the output stream to read from the object. Each time this method is
   * call, a new {@link OutputStream} needs to be created!
   *
   * @param eAppend
   *        appending mode. May not be null.
   * @return null if resolving failed.
   */
  @Nullable
  OutputStream getOutputStream (@Nonnull EAppend eAppend);

  /**
   * Get the output stream to read from the object. Each time this method is
   * call, a new {@link OutputStream} needs to be created. Internally invokes
   * {@link #getOutputStream(EAppend)}.
   *
   * @param eAppend
   *        appending mode. May not be null.
   * @return null if resolving failed.
   * @since 9.1.8
   */
  @Nullable
  default OutputStream getBufferedOutputStream (@Nonnull final EAppend eAppend)
  {
    return StreamHelper.getBuffered (getOutputStream (eAppend));
  }

  /**
   * Check if the {@link OutputStream} from {@link #getOutputStream(EAppend)} or
   * {@link #getBufferedOutputStream(EAppend)} can be acquired more than once or
   * not.
   *
   * @return true if the output stream can be acquired more than
   *         once, false if not.
   */
  boolean isWriteMultiple ();
}