com.helger.commons.io.IHasInputStream 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

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 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.InputStream;

import javax.annotation.Nullable;

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

/**
 * A callback interface to retrieve {@link InputStream} objects.
 *
 * @author Philip Helger
 */
public interface IHasInputStream
{
  /**
   * Get the input stream to read from the object. Each time this method is
   * called, a new {@link InputStream} needs to be created.
   *
   * @return null if resolving failed.
   */
  @Nullable
  InputStream getInputStream ();

  /**
   * Get a buffered input stream to read from the object. Each time this method
   * is called, a new {@link InputStream} needs to be created. Internally
   * invokes {@link #getInputStream()}.
   *
   * @return null if resolving failed.
   * @since 9.1.8
   */
  @Nullable
  default InputStream getBufferedInputStream ()
  {
    final InputStream aIS = getInputStream ();
    return aIS == null ? null : StreamHelper.getBuffered (aIS);
  }

  /**
   * Check if the {@link InputStream} from {@link #getInputStream()} and
   * {@link #getBufferedInputStream()} can be acquired more than once.
   *
   * @return true if the input stream can be acquired more than
   *         once, false if not.
   */
  boolean isReadMultiple ();
}