Home | History | Annotate | Download | only in io
      1 /*
      2  * Copyright (C) 2007 The Guava Authors
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  * http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.google.common.io;
     18 
     19 import java.io.IOException;
     20 
     21 /**
     22  * A factory for writable streams of bytes or characters.
     23  *
     24  * @author Chris Nokleberg
     25  * @since 1.0
     26  * @deprecated For {@code OutputSupplier<? extends OutputStream>}, use
     27  *     {@link ByteSink} instead. For {@code OutputSupplier<? extends Writer>},
     28  *     use {@link CharSink}. Implementations of {@code OutputSupplier} that
     29  *     don't fall into one of those categories do not benefit from any of the
     30  *     methods in {@code common.io} and should use a different interface. This
     31  *     interface is scheduled for removal in June 2015.
     32  */
     33 @Deprecated
     34 public interface OutputSupplier<T> {
     35 
     36   /**
     37    * Returns an object that encapsulates a writable resource.
     38    * <p>
     39    * Like {@link Iterable#iterator}, this method may be called repeatedly to
     40    * get independent channels to the same underlying resource.
     41    * <p>
     42    * Where the channel maintains a position within the resource, moving that
     43    * cursor within one channel should not affect the starting position of
     44    * channels returned by other calls.
     45    */
     46   T getOutput() throws IOException;
     47 }
     48