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