ByteArrayBuilder (NATS.IO Java API)

java.lang.Object
- io.nats.client.support.ByteArrayBuilder

public class ByteArrayBuilder
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_ASCII_ALLOCATION

static int DEFAULT_OTHER_ALLOCATION

static byte[] NULL

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ASCII_ALLOCATION`
`static int`	`DEFAULT_OTHER_ALLOCATION`
`static byte[]`	`NULL`

Constructor Summary

Constructors
Constructor and Description
`ByteArrayBuilder()` Construct the ByteArrayBuilder with the initial size and allocation size of 32 and the character set `StandardCharsets.US_ASCII`
`ByteArrayBuilder(byte[] bytes)` Construct the ByteArrayBuilder with an existing byte array using it's length as the initial length, the allocation size the larger of the length and 32, and the character set `StandardCharsets.US_ASCII` Then initializes the buffer with the supplied bytes
`ByteArrayBuilder(java.nio.charset.Charset defaultCharset)` Construct the ByteArrayBuilder with the supplied character set with the default initial size and allocation size determined by that character set
`ByteArrayBuilder(int initialSize)` Construct the ByteArrayBuilder with the supplied initial size, allocation size of 32 and the character set `StandardCharsets.US_ASCII`
`ByteArrayBuilder(int initialSize, java.nio.charset.Charset defaultCharset)` Construct the ByteArrayBuilder with the supplied initial size and character set with the allocation size determined by that character set.
`ByteArrayBuilder(int initialSize, int allocationSize, java.nio.charset.Charset defaultCharset)` Construct the ByteArrayBuilder with the supplied initial size, allocation size and character set

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteArrayBuilder`	`append(byte b)` Append a byte as is
`ByteArrayBuilder`	`append(byte[] src)` Append a byte array
`ByteArrayBuilder`	`append(byte[] src, int len)` Append a byte array
`ByteArrayBuilder`	`append(byte[] src, int offset, int len)` Append a byte array
`ByteArrayBuilder`	`append(ByteArrayBuilder bab)`
`ByteArrayBuilder`	`append(java.nio.CharBuffer src)` Append a CharBuffer with default charset.
`ByteArrayBuilder`	`append(java.nio.CharBuffer src, java.nio.charset.Charset charset)` Append a CharBuffer with specified charset.
`ByteArrayBuilder`	`append(int i)` Append a String representation of the number.
`ByteArrayBuilder`	`append(java.lang.String src)` Append a String with the default charset.
`ByteArrayBuilder`	`append(java.lang.String src, java.nio.charset.Charset charset)` Append a String with specified charset.
`ByteArrayBuilder`	`clear()` Clear the buffer, resetting it's length
`protected int`	`computeAmountToAllocate(int currentPosition, int bytesNeeded)`
`int`	`copyTo(byte[] dest, int destPos)` Copy the contents of the buffer to the byte array starting at the destination positions supplied.
`ByteArrayBuilder`	`ensureCapacity(int bytesNeeded)` Ensures that the buffer can accept the number of bytes needed Useful if the size of multiple append operations is known ahead of time therefore reducing the number of possible allocations during those appends
`boolean`	`equals(byte[] bytes)` Determine if a byte array contains the same bytes as this buffer
`byte[]`	`internalArray()` Access the internal byte array of this buffer.
`int`	`length()` Get the length of the data in the buffer
`ByteArrayBuilder`	`setAllocationSize(int allocationSize)` Change the allocation size
`byte[]`	`toByteArray()` Copy the value in the buffer to a new byte array
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ASCII_ALLOCATION
```
public static final int DEFAULT_ASCII_ALLOCATION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_OTHER_ALLOCATION
```
public static final int DEFAULT_OTHER_ALLOCATION
```
    See Also:
    
    Constant Field Values
  - NULL
```
public static final byte[] NULL
```
- Constructor Detail
  - ByteArrayBuilder
```
public ByteArrayBuilder()
```
    Construct the ByteArrayBuilder with the initial size and allocation size of 32 and the character set StandardCharsets.US_ASCII
  - ByteArrayBuilder
```
public ByteArrayBuilder(int initialSize)
```
    Construct the ByteArrayBuilder with the supplied initial size, allocation size of 32 and the character set StandardCharsets.US_ASCII
    
    Parameters:
    
    initialSize - the initial size
  - ByteArrayBuilder
```
public ByteArrayBuilder(byte[] bytes)
```
    Construct the ByteArrayBuilder with an existing byte array using it's length as the initial length, the allocation size the larger of the length and 32, and the character set StandardCharsets.US_ASCII Then initializes the buffer with the supplied bytes
    
    Parameters:
    
    bytes - the bytes
  - ByteArrayBuilder
```
public ByteArrayBuilder(java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayBuilder with the supplied character set with the default initial size and allocation size determined by that character set
    
    Parameters:
    
    defaultCharset - the default character set
  - ByteArrayBuilder
```
public ByteArrayBuilder(int initialSize,
                        java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayBuilder with the supplied initial size and character set with the allocation size determined by that character set.
    
    Parameters:
    
    initialSize - the initial size
    
    defaultCharset - the default character set
  - ByteArrayBuilder
```
public ByteArrayBuilder(int initialSize,
                        int allocationSize,
                        java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayBuilder with the supplied initial size, allocation size and character set
    
    Parameters:
    
    initialSize - the initial size
    
    allocationSize - the allocationSize size
    
    defaultCharset - the default character set
- Method Detail
  - length
```
public int length()
```
    Get the length of the data in the buffer
    
    Returns:
    
    the length of the data
  - equals
```
public boolean equals(byte[] bytes)
```
    Determine if a byte array contains the same bytes as this buffer
    
    Parameters:
    
    bytes - the bytes
    
    Returns:
    
    true if the supplied value equals what is in the buffer
  - copyTo
```
public int copyTo(byte[] dest,
                  int destPos)
```
    Copy the contents of the buffer to the byte array starting at the destination positions supplied. Assumes that the length() method has been called and the destination byte array has enough space allocated
    
    Parameters:
    
    dest - the destination byte array
    
    destPos - the starting position in the destination byte array
    
    Returns:
    
    the number of bytes copied
  - toByteArray
```
public byte[] toByteArray()
```
    Copy the value in the buffer to a new byte array
    
    Returns:
    
    the copy of the bytes
  - internalArray
```
public byte[] internalArray()
```
    Access the internal byte array of this buffer. Intended for read only with knowledge of length()
    
    Returns:
    
    a direct handle to the internal byte array
  - computeAmountToAllocate
```
protected int computeAmountToAllocate(int currentPosition,
                                      int bytesNeeded)
```
  - ensureCapacity
```
public ByteArrayBuilder ensureCapacity(int bytesNeeded)
```
    Ensures that the buffer can accept the number of bytes needed Useful if the size of multiple append operations is known ahead of time therefore reducing the number of possible allocations during those appends
    
    Parameters:
    
    bytesNeeded - the number of bytes needed
    
    Returns:
    
    this (fluent)
  - clear
```
public ByteArrayBuilder clear()
```
    Clear the buffer, resetting it's length
    
    Returns:
    
    this (fluent)
  - setAllocationSize
```
public ByteArrayBuilder setAllocationSize(int allocationSize)
```
    Change the allocation size
    
    Parameters:
    
    allocationSize - the new allocation size
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(int i)
```
    Append a String representation of the number.
    
    Parameters:
    
    i - the number
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(java.lang.String src)
```
    Append a String with the default charset. If the src is null, the word 'null' is appended.
    
    Parameters:
    
    src - The String from which bytes are to be read
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(java.lang.String src,
                               java.nio.charset.Charset charset)
```
    Append a String with specified charset. If the src is null, the word 'null' is appended.
    
    Parameters:
    
    src - The String from which bytes are to be read
    
    charset - the charset for encoding
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(java.nio.CharBuffer src)
```
    Append a CharBuffer with default charset. If the src is null, the word 'null' is appended.
    
    Parameters:
    
    src - The CharBuffer from which bytes are to be read
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(java.nio.CharBuffer src,
                               java.nio.charset.Charset charset)
```
    Append a CharBuffer with specified charset. If the src is null, the word 'null' is appended.
    
    Parameters:
    
    src - The CharBuffer from which bytes are to be read
    
    charset - the charset for encoding
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(byte b)
```
    Append a byte as is
    
    Parameters:
    
    b - the byte
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(byte[] src)
```
    Append a byte array
    
    Parameters:
    
    src - The array from which bytes are to be read
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(byte[] src,
                               int len)
```
    Append a byte array
    
    Parameters:
    
    src - The array from which bytes are to be read
    
    len - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(byte[] src,
                               int offset,
                               int len)
```
    Append a byte array
    
    Parameters:
    
    src - The array from which bytes are to be read
    
    offset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.length
    
    len - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayBuilder append(ByteArrayBuilder bab)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ByteArrayBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ASCII_ALLOCATION

DEFAULT_OTHER_ALLOCATION

NULL

Constructor Detail

ByteArrayBuilder

ByteArrayBuilder

ByteArrayBuilder

ByteArrayBuilder

ByteArrayBuilder

ByteArrayBuilder

Method Detail

length

equals

copyTo

toByteArray

internalArray

computeAmountToAllocate

ensureCapacity

clear

setAllocationSize

append

append

append

append

append

append

append

append

append

append

toString