001/*
002 * Copyright (C) 2007 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.io;
018
019import java.io.IOException;
020
021/**
022 * A factory for readable streams of bytes or characters.
023 *
024 * @author Chris Nokleberg
025 * @since 1.0
026 * @deprecated For {@code InputSupplier<? extends InputStream>}, use
027 *     {@link ByteSource} instead. For {@code InputSupplier<? extends Reader>},
028 *     use {@link CharSource}. Implementations of {@code InputSupplier} that
029 *     don't fall into one of those categories do not benefit from any of the
030 *     methods in {@code common.io} and should use a different interface. This
031 *     interface is scheduled for removal in December 2015.
032 */
033@Deprecated
034public interface InputSupplier<T> {
035
036  /**
037   * Returns an object that encapsulates a readable resource.
038   * <p>
039   * Like {@link Iterable#iterator}, this method may be called repeatedly to
040   * get independent channels to the same underlying resource.
041   * <p>
042   * Where the channel maintains a position within the resource, moving that
043   * cursor within one channel should not affect the starting position of
044   * channels returned by other calls.
045   */
046  T getInput() throws IOException;
047}