001    /*
002     * Copyright (C) 2011 The Guava Authors
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005     * in compliance with the License. You may obtain a copy of the License at
006     *
007     * http://www.apache.org/licenses/LICENSE-2.0
008     *
009     * Unless required by applicable law or agreed to in writing, software distributed under the License
010     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011     * or implied. See the License for the specific language governing permissions and limitations under
012     * the License.
013     */
014    
015    package com.google.common.hash;
016    
017    import com.google.common.annotations.Beta;
018    
019    /**
020     * An object which can send data from an object of type {@code T} into a {@code Sink}.
021     * 
022     * @author Dimitris Andreou
023     * @since 11.0
024     */
025    @Beta
026    public interface Funnel<T> {
027      /**
028       * Sends a stream of data from the {@code from} object into the sink {@code into}. There
029       * is no requirement that this data be complete enough to fully reconstitute the object
030       * later.
031       */
032      void funnel(T from, Sink into);
033    }