com.google.common.hash.Funnel Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2011 The Guava Authors
*
* 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.google.common.hash;
import com.google.common.annotations.Beta;
import java.io.Serializable;
/**
* An object which can send data from an object of type {@code T} into a {@code PrimitiveSink}.
*
* @author Dimitris Andreou
* @since 11.0
*/
@Beta
public interface Funnel extends Serializable {
/**
* Sends a stream of data from the {@code from} object into the sink {@code into}. There
* is no requirement that this data be complete enough to fully reconstitute the object
* later.
*
* @since 12.0 (in 11.0 version, {@code PrimitiveSink} was still called {@code Sink})
*/
void funnel(T from, PrimitiveSink into);
}