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;
018import com.google.errorprone.annotations.CanIgnoreReturnValue;
019import java.nio.ByteBuffer;
020import java.nio.charset.Charset;
021
022/**
023 * An object which can receive a stream of primitive values.
024 *
025 * @author Kevin Bourrillion
026 * @since 12.0 (in 11.0 as {@code Sink})
027 */
028@Beta
029@CanIgnoreReturnValue
030public interface PrimitiveSink {
031  /**
032   * Puts a byte into this sink.
033   *
034   * @param b a byte
035   * @return this instance
036   */
037  PrimitiveSink putByte(byte b);
038
039  /**
040   * Puts an array of bytes into this sink.
041   *
042   * @param bytes a byte array
043   * @return this instance
044   */
045  PrimitiveSink putBytes(byte[] bytes);
046
047  /**
048   * Puts a chunk of an array of bytes into this sink. {@code bytes[off]} is the first byte written,
049   * {@code bytes[off + len - 1]} is the last.
050   *
051   * @param bytes a byte array
052   * @param off the start offset in the array
053   * @param len the number of bytes to write
054   * @return this instance
055   * @throws IndexOutOfBoundsException if {@code off < 0} or {@code off + len > bytes.length} or
056   *     {@code len < 0}
057   */
058  PrimitiveSink putBytes(byte[] bytes, int off, int len);
059
060  /**
061   * Puts the remaining bytes of a byte buffer into this sink. {@code bytes.position()} is the first
062   * byte written, {@code bytes.limit() - 1} is the last. The position of the buffer will be equal
063   * to the limit when this method returns.
064   *
065   * @param bytes a byte buffer
066   * @return this instance
067   * @since 23.0
068   */
069  PrimitiveSink putBytes(ByteBuffer bytes);
070
071  /**
072   * Puts a short into this sink.
073   */
074  PrimitiveSink putShort(short s);
075
076  /**
077   * Puts an int into this sink.
078   */
079  PrimitiveSink putInt(int i);
080
081  /**
082   * Puts a long into this sink.
083   */
084  PrimitiveSink putLong(long l);
085
086  /**
087   * Puts a float into this sink.
088   */
089  PrimitiveSink putFloat(float f);
090
091  /**
092   * Puts a double into this sink.
093   */
094  PrimitiveSink putDouble(double d);
095
096  /**
097   * Puts a boolean into this sink.
098   */
099  PrimitiveSink putBoolean(boolean b);
100
101  /**
102   * Puts a character into this sink.
103   */
104  PrimitiveSink putChar(char c);
105
106  /**
107   * Puts each 16-bit code unit from the {@link CharSequence} into this sink.
108   *
109   * <p><b>Warning:</b> This method will produce different output than most other languages do when
110   * running on the equivalent input. For cross-language compatibility, use {@link #putString},
111   * usually with a charset of UTF-8. For other use cases, use {@code putUnencodedChars}.
112   *
113   * @since 15.0 (since 11.0 as putString(CharSequence))
114   */
115  PrimitiveSink putUnencodedChars(CharSequence charSequence);
116
117  /**
118   * Puts a string into this sink using the given charset.
119   *
120   * <p><b>Warning:</b> This method, which reencodes the input before processing it, is useful only
121   * for cross-language compatibility. For other use cases, prefer {@link #putUnencodedChars}, which
122   * is faster, produces the same output across Java releases, and processes every {@code char} in
123   * the input, even if some are invalid.
124   */
125  PrimitiveSink putString(CharSequence charSequence, Charset charset);
126}