/*
 * 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<T> 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);
}

@@ -800,12 +800,708 @@
 k%7D.%0A
+ *%0A * %3Cp%3ENote that serialization of %7B@linkplain BloomFilter bloom filters%7D requires the proper%0A * serialization of funnels. When possible, it is recommended that funnels be implemented as a%0A * single-element enum to maintain serialization guarantees. See Effective Java (2nd Edition),%0A * Item 3: %22Enforce the singleton property with a private constructor or an enum type%22. For example:%0A * %3Cpre%3E   %7B@code%0A *   public enum PersonFunnel implements Funnel%3CPerson%3E %7B%0A *     INSTANCE;%0A *     public void funnel(Person person, PrimitiveSink into) %7B%0A *       into.putString(person.getFirstName())%0A *           .putString(person.getLastName())%0A *           .putInt(person.getAge());%0A *     %7D%0A *   %7D%3C/pre%3E%0A
  * %0A
-
  * @
@@ -1829,20 +1829,18 @@
 (in 
-11.0 version
+Guava 11.0
 , %7B@
@@ -1867,18 +1867,11 @@
 was 
-still call
+nam
 ed %7B

Improve Funnel javadocs about using an enum. ------------- Created by MOE: http://code.google.com/p/moe-java MOE_MIGRATED_REVID=32878801