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
015package com.google.common.hash;
016
017import com.google.common.annotations.Beta;
018
019import java.nio.charset.Charset;
020
021/**
022 * A {@link PrimitiveSink} that can compute a hash code after reading the input. Each hasher should
023 * translate all multibyte values ({@link #putInt(int)}, {@link #putLong(long)}, etc) to bytes
024 * in little-endian order.
025 *
026 * <p><b>Warning:</b> The result of calling any methods after calling {@link #hash} is undefined.
027 *
028 * <p><b>Warning:</b> Using a specific character encoding when hashing a {@link CharSequence} with
029 * {@link #putString(CharSequence, Charset)} is generally only useful for cross-language
030 * compatibility (otherwise prefer {@link #putUnencodedChars}). However, the character encodings
031 * must be identical across languages. Also beware that {@link Charset} definitions may occasionally
032 * change between Java releases.
033 *
034 * <p><b>Warning:</b> Chunks of data that are put into the {@link Hasher} are not delimited.
035 * The resulting {@link HashCode} is dependent only on the bytes inserted, and the order in which
036 * they were inserted, not how those bytes were chunked into discrete put() operations. For example,
037 * the following three expressions all generate colliding hash codes: <pre>   {@code
038 *
039 *   newHasher().putByte(b1).putByte(b2).putByte(b3).hash()
040 *   newHasher().putByte(b1).putBytes(new byte[] { b2, b3 }).hash()
041 *   newHasher().putBytes(new byte[] { b1, b2, b3 }).hash()}</pre>
042 *
043 * <p>If you wish to avoid this, you should either prepend or append the size of each chunk. Keep in
044 * mind that when dealing with char sequences, the encoded form of two concatenated char sequences
045 * is not equivalent to the concatenation of their encoded form. Therefore,
046 * {@link #putString(CharSequence, Charset)} should only be used consistently with <i>complete</i>
047 * sequences and not broken into chunks.
048 *
049 * @author Kevin Bourrillion
050 * @since 11.0
051 */
052@Beta
053public interface Hasher extends PrimitiveSink {
054  @Override Hasher putByte(byte b);
055  @Override Hasher putBytes(byte[] bytes);
056  @Override Hasher putBytes(byte[] bytes, int off, int len);
057  @Override Hasher putShort(short s);
058  @Override Hasher putInt(int i);
059  @Override Hasher putLong(long l);
060
061  /**
062   * Equivalent to {@code putInt(Float.floatToRawIntBits(f))}.
063   */
064  @Override Hasher putFloat(float f);
065
066  /**
067   * Equivalent to {@code putLong(Double.doubleToRawLongBits(d))}.
068   */
069  @Override Hasher putDouble(double d);
070
071  /**
072   * Equivalent to {@code putByte(b ? (byte) 1 : (byte) 0)}.
073   */
074  @Override Hasher putBoolean(boolean b);
075  @Override Hasher putChar(char c);
076
077  /**
078   * Equivalent to processing each {@code char} value in the {@code CharSequence}, in order.
079   * The input must not be updated while this method is in progress.
080   *
081   * @since 15.0 (since 11.0 as putString(CharSequence)).
082   */
083  @Override Hasher putUnencodedChars(CharSequence charSequence);
084
085  /**
086   * Equivalent to processing each {@code char} value in the {@code CharSequence}, in order.
087   * The input must not be updated while this method is in progress.
088   *
089   * @deprecated Use {@link Hasher#putUnencodedChars} instead. This method is scheduled for
090   *     removal in Guava 16.0.
091   */
092  @Deprecated
093  @Override Hasher putString(CharSequence charSequence);
094
095  /**
096   * Equivalent to {@code putBytes(charSequence.toString().getBytes(charset))}.
097   */
098  @Override Hasher putString(CharSequence charSequence, Charset charset);
099
100  /**
101   * A simple convenience for {@code funnel.funnel(object, this)}.
102   */
103  <T> Hasher putObject(T instance, Funnel<? super T> funnel);
104
105  /**
106   * Computes a hash code based on the data that have been provided to this hasher. The result is
107   * unspecified if this method is called more than once on the same instance.
108   */
109  HashCode hash();
110}