io.vertx/vertx-core/4.0.0 : io/vertx/core/buffer/Buffer.java

Buffer
http://nexus.sonatype.org/oss-repository-hosting.html/vertx-parent/vertx-core: Sonatype helps open source projects to set up Maven repositories on https://oss.sonatype.org/ (Eclipse)
/*
 * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.buffer;


import io.netty.buffer.ByteBuf;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.buffer.impl.BufferImpl;
import io.vertx.core.json.Json;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.core.shareddata.Shareable;
import io.vertx.core.shareddata.impl.ClusterSerializable;

import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.util.Objects;

Most data is shuffled around inside Vert.x using buffers.

A buffer is a sequence of zero or more bytes that can read from or written to and which expands automatically as
necessary to accommodate any bytes written to it. You can perhaps think of a buffer as smart byte array.

Please consult the documentation for more information on buffers.
Author: Tim Fox/**
 * Most data is shuffled around inside Vert.x using buffers.
 * <p>
 * A buffer is a sequence of zero or more bytes that can read from or written to and which expands automatically as
 * necessary to accommodate any bytes written to it. You can perhaps think of a buffer as smart byte array.
 * <p>
 * Please consult the documentation for more information on buffers.
 *
 * @author <a href="http://tfox.org">Tim Fox</a>
 */
@VertxGen
public interface Buffer extends ClusterSerializable, Shareable {

  Create a new, empty buffer.
Returns: the buffer/**
   * Create a new, empty buffer.
   *
   * @return the buffer
   */
  static Buffer buffer() {
    return BufferImpl.buffer();
  }

  Create a new buffer given the initial size hint.

If you know the buffer will require a certain size, providing the hint can prevent unnecessary re-allocations
as the buffer is written to and resized.
Params: initialSizeHint – the hint, in bytes
Returns: the buffer/**
   * Create a new buffer given the initial size hint.
   * <p>
   * If you know the buffer will require a certain size, providing the hint can prevent unnecessary re-allocations
   * as the buffer is written to and resized.
   *
   * @param initialSizeHint the hint, in bytes
   * @return the buffer
   */
  static Buffer buffer(int initialSizeHint) {
    return BufferImpl.buffer(initialSizeHint);
  }

  Create a new buffer from a string. The string will be UTF-8 encoded into the buffer.
Params: string – the string
Returns: the buffer/**
   * Create a new buffer from a string. The string will be UTF-8 encoded into the buffer.
   *
   * @param string the string
   * @return the buffer
   */
  static Buffer buffer(String string) {
    return BufferImpl.buffer(string);
  }

  Create a new buffer from a string and using the specified encoding.
The string will be encoded into the buffer using the specified encoding.
Params: string – the string
Returns: the buffer/**
   * Create a new buffer from a string and using the specified encoding.
   * The string will be encoded into the buffer using the specified encoding.
   *
   * @param string the string
   * @return the buffer
   */
  static Buffer buffer(String string, String enc) {
    return BufferImpl.buffer(string, enc);
  }

  Create a new buffer from a byte[]. The byte[] will be copied to form the buffer.
Params: bytes – the byte array
Returns: the buffer/**
   * Create a new buffer from a byte[]. The byte[] will be copied to form the buffer.
   *
   * @param bytes the byte array
   * @return the buffer
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  static Buffer buffer(byte[] bytes) {
    return BufferImpl.buffer(bytes);
  }

   Create a new buffer from a Netty ByteBuf. Note that the returned buffer is backed by given Netty ByteBuf,
so changes in the returned buffer are reflected in given Netty ByteBuf, and vice-versa.


For example, both buffers in the code below share their data:

  Buffer src = Buffer.buffer();
  Buffer clone = Buffer.buffer(src.getByteBuf());

Params: byteBuf – the Netty ByteBuf
Returns: the buffer/**
   * <p>
   * Create a new buffer from a Netty {@code ByteBuf}.
   * <i>Note that</i> the returned buffer is backed by given Netty ByteBuf,
   * so changes in the returned buffer are reflected in given Netty ByteBuf, and vice-versa.
   * </p>
   * <p>
   * For example, both buffers in the code below share their data:
   * </p>
   * <pre>
   *   Buffer src = Buffer.buffer();
   *   Buffer clone = Buffer.buffer(src.getByteBuf());
   * </pre>
   *
   * @param byteBuf the Netty ByteBuf
   * @return the buffer
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  static Buffer buffer(ByteBuf byteBuf) {
    Objects.requireNonNull(byteBuf);
    return BufferImpl.buffer(byteBuf);
  }

  Returns a String representation of the Buffer with the UTF-8 encoding /**
   * Returns a {@code String} representation of the Buffer with the {@code UTF-8 }encoding
   */
  String toString();

  Returns a String representation of the Buffer with the encoding specified by enc /**
   * Returns a {@code String} representation of the Buffer with the encoding specified by {@code enc}
   */
  String toString(String enc);

  Returns a String representation of the Buffer with the encoding specified by enc /**
   * Returns a {@code String} representation of the Buffer with the encoding specified by {@code enc}
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  String toString(Charset enc);

  Returns a Json object representation of the Buffer.
/**
   * Returns a Json object representation of the Buffer.
   */
  JsonObject toJsonObject();

  Returns a Json array representation of the Buffer.
/**
   * Returns a Json array representation of the Buffer.
   */
  JsonArray toJsonArray();

  Returns a Json representation of the Buffer.
Returns: a JSON element which can be a JsonArray, JsonObject, String, ...etc if the buffer contains an array, object, string, ...etc/**
   * Returns a Json representation of the Buffer.
   *
   * @return a JSON element which can be a {@link JsonArray}, {@link JsonObject}, {@link String}, ...etc if the buffer contains an array, object, string, ...etc
   */
  default Object toJson() {
    return Json.CODEC.fromBuffer(this, Object.class);
  }

  Returns the byte at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 1 is greater than the length of the Buffer./**
   * Returns the {@code byte} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 1} is greater than the length of the Buffer.
   */
  byte getByte(int pos);

  Returns the unsigned byte at position pos in the Buffer, as a short. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 1 is greater than the length of the Buffer./**
   * Returns the unsigned {@code byte} at position {@code pos} in the Buffer, as a {@code short}.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 1} is greater than the length of the Buffer.
   */
  short getUnsignedByte(int pos);

  Returns the int at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 4 is greater than the length of the Buffer./**
   * Returns the {@code int} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 4} is greater than the length of the Buffer.
   */
  int getInt(int pos);

  Gets a 32-bit integer at the specified absolute index in this buffer with Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 4 is greater than this.capacity/**
   * Gets a 32-bit integer at the specified absolute {@code index} in this buffer with Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 4} is greater than {@code this.capacity}
   */
  int getIntLE(int pos);

  Returns the unsigned int at position pos in the Buffer, as a long. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 4 is greater than the length of the Buffer./**
   * Returns the unsigned {@code int} at position {@code pos} in the Buffer, as a {@code long}.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 4} is greater than the length of the Buffer.
   */
  long getUnsignedInt(int pos);

  Returns the unsigned int at position pos in the Buffer, as a long in Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 4 is greater than the length of the Buffer./**
   * Returns the unsigned {@code int} at position {@code pos} in the Buffer, as a {@code long} in Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 4} is greater than the length of the Buffer.
   */
  long getUnsignedIntLE(int pos);

  Returns the long at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 8 is greater than the length of the Buffer./**
   * Returns the {@code long} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 8} is greater than the length of the Buffer.
   */
  long getLong(int pos);

  Gets a 64-bit long integer at the specified absolute index in this buffer in Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 8 is greater than the length of the Buffer./**
   * Gets a 64-bit long integer at the specified absolute {@code index} in this buffer in Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 8} is greater than the length of the Buffer.
   */
  long getLongLE(int pos);

  Returns the double at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 8 is greater than the length of the Buffer./**
   * Returns the {@code double} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 8} is greater than the length of the Buffer.
   */
  double getDouble(int pos);

  Returns the float at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 4 is greater than the length of the Buffer./**
   * Returns the {@code float} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 4} is greater than the length of the Buffer.
   */
  float getFloat(int pos);

  Returns the short at position pos in the Buffer. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 2 is greater than the length of the Buffer./**
   * Returns the {@code short} at position {@code pos} in the Buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 2} is greater than the length of the Buffer.
   */
  short getShort(int pos);

  Gets a 16-bit short integer at the specified absolute index in this buffer in Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 2 is greater than the length of the Buffer./**
   * Gets a 16-bit short integer at the specified absolute {@code index} in this buffer in Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 2} is greater than the length of the Buffer.
   */
  short getShortLE(int pos);

  Returns the unsigned short at position pos in the Buffer, as an int. 
Throws: IndexOutOfBoundsException – if the specified pos is less than 0 or pos + 2 is greater than the length of the Buffer./**
   * Returns the unsigned {@code short} at position {@code pos} in the Buffer, as an {@code int}.
   *
   * @throws IndexOutOfBoundsException if the specified {@code pos} is less than {@code 0} or {@code pos + 2} is greater than the length of the Buffer.
   */
  int getUnsignedShort(int pos);

  Gets an unsigned 16-bit short integer at the specified absolute index in this buffer in Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 2 is greater than the length of the Buffer./**
   * Gets an unsigned 16-bit short integer at the specified absolute {@code index} in this buffer in Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 2} is greater than the length of the Buffer.
   */
  int getUnsignedShortLE(int pos);

  Gets a 24-bit medium integer at the specified absolute index in this buffer. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 3 is greater than the length of the Buffer./**
   * Gets a 24-bit medium integer at the specified absolute {@code index} in this buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 3} is greater than the length of the Buffer.
   */
  int getMedium(int pos);

  Gets a 24-bit medium integer at the specified absolute index in this buffer in the Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 3 is greater than the length of the Buffer./**
   * Gets a 24-bit medium integer at the specified absolute {@code index} in this buffer in the Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 3} is greater than the length of the Buffer.
   */
  int getMediumLE(int pos);

  Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 3 is greater than the length of the Buffer./**
   * Gets an unsigned 24-bit medium integer at the specified absolute {@code index} in this buffer.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 3} is greater than the length of the Buffer.
   */
  int getUnsignedMedium(int pos);

  Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer in Little Endian Byte Order. 
Throws: IndexOutOfBoundsException – if the specified index is less than 0 or index + 3 is greater than the length of the Buffer./**
   * Gets an unsigned 24-bit medium integer at the specified absolute {@code index} in this buffer in Little Endian Byte Order.
   *
   * @throws IndexOutOfBoundsException if the specified {@code index} is less than {@code 0} or {@code index + 3} is greater than the length of the Buffer.
   */
  int getUnsignedMediumLE(int pos);

  Returns a copy of the entire Buffer as a byte[] /**
   * Returns a copy of the entire Buffer as a {@code byte[]}
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  byte[] getBytes();

  Returns a copy of a sub-sequence the Buffer as a byte[] starting at position start and ending at position end - 1 /**
   * Returns a copy of a sub-sequence the Buffer as a {@code byte[]} starting at position {@code start}
   * and ending at position {@code end - 1}
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  byte[] getBytes(int start, int end);

  Transfers the content of the Buffer into a byte[]. 
Params: dst – the destination byte array
Throws: IndexOutOfBoundsException – if the content of the Buffer cannot fit into the destination byte array/**
   * Transfers the content of the Buffer into a {@code byte[]}.
   *
   * @param dst the destination byte array
   * @throws IndexOutOfBoundsException if the content of the Buffer cannot fit into the destination byte array
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer getBytes(byte[] dst);

  Transfers the content of the Buffer into a byte[] at the specific destination. 
Params: dst – the destination byte array
Throws: IndexOutOfBoundsException – if the content of the Buffer cannot fit into the destination byte array/**
   * Transfers the content of the Buffer into a {@code byte[]} at the specific destination.
   *
   * @param dst the destination byte array
   * @throws IndexOutOfBoundsException if the content of the Buffer cannot fit into the destination byte array
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer getBytes(byte[] dst, int dstIndex);

  Transfers the content of the Buffer starting at position start and ending at position end - 1 into a byte[]. 
Params: dst – the destination byte array
Throws: IndexOutOfBoundsException – if the content of the Buffer cannot fit into the destination byte array/**
   * Transfers the content of the Buffer starting at position {@code start} and ending at position {@code end - 1}
   * into a {@code byte[]}.
   *
   * @param dst the destination byte array
   * @throws IndexOutOfBoundsException if the content of the Buffer cannot fit into the destination byte array
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer getBytes(int start, int end, byte[] dst);

  Transfers the content of the Buffer starting at position start and ending at position end - 1 into a byte[] at the specific destination. 
Params: dst – the destination byte array
Throws: IndexOutOfBoundsException – if the content of the Buffer cannot fit into the destination byte array/**
   * Transfers the content of the Buffer starting at position {@code start} and ending at position {@code end - 1}
   * into a {@code byte[]} at the specific destination.
   *
   * @param dst the destination byte array
   * @throws IndexOutOfBoundsException if the content of the Buffer cannot fit into the destination byte array
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer getBytes(int start, int end, byte[] dst, int dstIndex);

  Returns a copy of a sub-sequence the Buffer as a Buffer starting at position start and ending at position end - 1 /**
   * Returns a copy of a sub-sequence the Buffer as a {@link io.vertx.core.buffer.Buffer} starting at position {@code start}
   * and ending at position {@code end - 1}
   */
  Buffer getBuffer(int start, int end);

  Returns a copy of a sub-sequence the Buffer as a String starting at position start and ending at position end - 1 interpreted as a String in the specified encoding /**
   * Returns a copy of a sub-sequence the Buffer as a {@code String} starting at position {@code start}
   * and ending at position {@code end - 1} interpreted as a String in the specified encoding
   */
  String getString(int start, int end, String enc);

  Returns a copy of a sub-sequence the Buffer as a String starting at position start and ending at position end - 1 interpreted as a String in UTF-8 encoding /**
   * Returns a copy of a sub-sequence the Buffer as a {@code String} starting at position {@code start}
   * and ending at position {@code end - 1} interpreted as a String in UTF-8 encoding
   */
  String getString(int start, int end);

  Appends the specified Buffer to the end of this Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code Buffer} to the end of this Buffer. The buffer will expand as necessary to accommodate
   * any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendBuffer(Buffer buff);

  Appends the specified Buffer starting at the offset using len to the end of this Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code Buffer} starting at the {@code offset} using {@code len} to the end of this Buffer. The buffer will expand as necessary to accommodate
   * any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendBuffer(Buffer buff, int offset, int len);

  Appends the specified byte[] to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code byte[]} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer appendBytes(byte[] bytes);

  Appends the specified number of bytes from byte[] to the end of the Buffer, starting at the given offset. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified number of bytes from {@code byte[]} to the end of the Buffer, starting at the given offset.
   * The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer appendBytes(byte[] bytes, int offset, int len);

  Appends the specified byte to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code byte} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendByte(byte b);

  Appends the specified unsigned byte to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified unsigned {@code byte} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendUnsignedByte(short b);

  Appends the specified int to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code int} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendInt(int i);

  Appends the specified int to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code int} to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendIntLE(int i);

  Appends the specified unsigned int to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified unsigned {@code int} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendUnsignedInt(long i);

  Appends the specified unsigned int to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified unsigned {@code int} to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendUnsignedIntLE(long i);

  Appends the specified 24bit int to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified 24bit {@code int} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendMedium(int i);

  Appends the specified 24bit int to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified 24bit {@code int} to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendMediumLE(int i);

  Appends the specified long to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code long} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendLong(long l);

  Appends the specified long to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code long} to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendLongLE(long l);

  Appends the specified short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code short} to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendShort(short s);

  Appends the specified short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code short} to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendShortLE(short s);

  Appends the specified unsigned short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified unsigned {@code short} to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendUnsignedShort(int s);

  Appends the specified unsigned short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified unsigned {@code short} to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendUnsignedShortLE(int s);

  Appends the specified float to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code float} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendFloat(float f);

  Appends the specified double to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written. Returns a reference to this so multiple operations can be appended together. /**
   * Appends the specified {@code double} to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.
   */
  @Fluent
  Buffer appendDouble(double d);

  Appends the specified String to the end of the Buffer with the encoding as specified by enc.
The buffer will expand as necessary to accommodate any bytes written.
 Returns a reference to this so multiple operations can be appended together.

/**
   * Appends the specified {@code String} to the end of the Buffer with the encoding as specified by {@code enc}.<p>
   * The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together.<p>
   */
  @Fluent
  Buffer appendString(String str, String enc);

  Appends the specified String str to the end of the Buffer with UTF-8 encoding.
The buffer will expand as necessary to accommodate any bytes written.
 Returns a reference to this so multiple operations can be appended together

/**
   * Appends the specified {@code String str} to the end of the Buffer with UTF-8 encoding.<p>
   * The buffer will expand as necessary to accommodate any bytes written.<p>
   * Returns a reference to {@code this} so multiple operations can be appended together<p>
   */
  @Fluent
  Buffer appendString(String str);

  Sets the byte at position pos in the Buffer to the value b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code byte} at position {@code pos} in the Buffer to the value {@code b}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setByte(int pos, byte b);

  Sets the unsigned byte at position pos in the Buffer to the value b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the unsigned {@code byte} at position {@code pos} in the Buffer to the value {@code b}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setUnsignedByte(int pos, short b);

  Sets the int at position pos in the Buffer to the value i.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code int} at position {@code pos} in the Buffer to the value {@code i}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setInt(int pos, int i);

  Sets the int at position pos in the Buffer to the value i in the Little Endian Byte Order.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code int} at position {@code pos} in the Buffer to the value {@code i} in the Little Endian Byte Order.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setIntLE(int pos, int i);

  Sets the unsigned int at position pos in the Buffer to the value i.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the unsigned {@code int} at position {@code pos} in the Buffer to the value {@code i}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setUnsignedInt(int pos, long i);

  Sets the unsigned int at position pos in the Buffer to the value i in the Little Endian Byte Order.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the unsigned {@code int} at position {@code pos} in the Buffer to the value {@code i} in the Little Endian Byte Order.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setUnsignedIntLE(int pos, long i);

  Sets the 24bit int at position pos in the Buffer to the value i.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the 24bit {@code int} at position {@code pos} in the Buffer to the value {@code i}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setMedium(int pos, int i);

  Sets the 24bit int at position pos in the Buffer to the value i. in the Little Endian Byte Order
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the 24bit {@code int} at position {@code pos} in the Buffer to the value {@code i}. in the Little Endian Byte Order<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setMediumLE(int pos, int i);

  Sets the long at position pos in the Buffer to the value l.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code long} at position {@code pos} in the Buffer to the value {@code l}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setLong(int pos, long l);

  Sets the long at position pos in the Buffer to the value l in the Little Endian Byte Order.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code long} at position {@code pos} in the Buffer to the value {@code l} in the Little Endian Byte Order.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setLongLE(int pos, long l);

  Sets the double at position pos in the Buffer to the value d.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code double} at position {@code pos} in the Buffer to the value {@code d}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setDouble(int pos, double d);

  Sets the float at position pos in the Buffer to the value f.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code float} at position {@code pos} in the Buffer to the value {@code f}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setFloat(int pos, float f);

  Sets the short at position pos in the Buffer to the value s.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code short} at position {@code pos} in the Buffer to the value {@code s}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setShort(int pos, short s);

  Sets the short at position pos in the Buffer to the value s in the Little Endian Byte Order.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the {@code short} at position {@code pos} in the Buffer to the value {@code s} in the Little Endian Byte Order.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setShortLE(int pos, short s);

  Sets the unsigned short at position pos in the Buffer to the value s.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the unsigned {@code short} at position {@code pos} in the Buffer to the value {@code s}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setUnsignedShort(int pos, int s);

  Sets the unsigned short at position pos in the Buffer to the value s in the Little Endian Byte Order.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the unsigned {@code short} at position {@code pos} in the Buffer to the value {@code s} in the Little Endian Byte Order.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setUnsignedShortLE(int pos, int s);

  Sets the bytes at position pos in the Buffer to the bytes represented by the Buffer b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the bytes represented by the {@code Buffer b}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setBuffer(int pos, Buffer b);

  Sets the bytes at position pos in the Buffer to the bytes represented by the Buffer b on the given offset and len.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the bytes represented by the {@code Buffer b} on the given {@code offset} and {@code len}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setBuffer(int pos, Buffer b, int offset, int len);

  Sets the bytes at position pos in the Buffer to the bytes represented by the ByteBuffer b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the bytes represented by the {@code ByteBuffer b}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer setBytes(int pos, ByteBuffer b);

  Sets the bytes at position pos in the Buffer to the bytes represented by the byte[] b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the bytes represented by the {@code byte[] b}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer setBytes(int pos, byte[] b);

  Sets the given number of bytes at position pos in the Buffer to the bytes represented by the byte[] b.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the given number of bytes at position {@code pos} in the Buffer to the bytes represented by the {@code byte[] b}.<p></p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  Buffer setBytes(int pos, byte[] b, int offset, int len);

  Sets the bytes at position pos in the Buffer to the value of str encoded in UTF-8.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the value of {@code str} encoded in UTF-8.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setString(int pos, String str);

  Sets the bytes at position pos in the Buffer to the value of str encoded in encoding enc.
The buffer will expand as necessary to accommodate any value written.
/**
   * Sets the bytes at position {@code pos} in the Buffer to the value of {@code str} encoded in encoding {@code enc}.<p>
   * The buffer will expand as necessary to accommodate any value written.
   */
  @Fluent
  Buffer setString(int pos, String str, String enc);

  Returns the length of the buffer, measured in bytes.
All positions are indexed from zero.
/**
   * Returns the length of the buffer, measured in bytes.
   * All positions are indexed from zero.
   */
  int length();

  Returns a copy of the entire Buffer.
/**
   * Returns a copy of the entire Buffer.
   */
  Buffer copy();

  Returns a slice of this buffer. Modifying the content
of the returned buffer or this buffer affects each other's content
while they maintain separate indexes and marks.
/**
   * Returns a slice of this buffer. Modifying the content
   * of the returned buffer or this buffer affects each other's content
   * while they maintain separate indexes and marks.
   */
  Buffer slice();

  Returns a slice of this buffer. Modifying the content
of the returned buffer or this buffer affects each other's content
while they maintain separate indexes and marks.
/**
   * Returns a slice of this buffer. Modifying the content
   * of the returned buffer or this buffer affects each other's content
   * while they maintain separate indexes and marks.
   */
  Buffer slice(int start, int end);

  Returns the Buffer as a Netty ByteBuf.  The returned buffer is a duplicate that maintain its own indices.
/**
   * Returns the Buffer as a Netty {@code ByteBuf}.
   *
   * <p> The returned buffer is a duplicate that maintain its own indices.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  ByteBuf getByteBuf();

}
Params:	initialSizeHint – the hint, in bytes
Returns:	the buffer
Params:	dst – the destination byte array
Throws:	IndexOutOfBoundsException – if the content of the Buffer cannot fit into the destination byte array
/

io.vertx/ vertx-core/ 4.0.0/ io/vertx/core/buffer/Buffer.java
