ByteArrayPrimitiveBuilder (NATS.IO Java API)

java.lang.Object
- io.nats.client.support.BuilderBase
- - io.nats.client.support.ByteArrayPrimitiveBuilder

public class ByteArrayPrimitiveBuilder
extends BuilderBase

Field Summary
- Fields inherited from class io.nats.client.support.BuilderBase
  ALLOCATION_BOUNDARY, allocationSize, DEFAULT_ASCII_ALLOCATION, DEFAULT_OTHER_ALLOCATION, defaultCharset, NULL

Constructor Summary

Constructors
Constructor and Description
`ByteArrayPrimitiveBuilder()` Construct the ByteArrayPrimitiveBuilder with the initial size and allocation size of and the character set `StandardCharsets.US_ASCII`
`ByteArrayPrimitiveBuilder(byte[] bytes)` Construct the ByteArrayPrimitiveBuilder copying all the bytes using the character set `StandardCharsets.US_ASCII` Then initializes the buffer with the supplied bytes
`ByteArrayPrimitiveBuilder(byte[] bytes, int len)` Construct the ByteArrayPrimitiveBuilder copying the specified number of bytes; and the character set `StandardCharsets.US_ASCII` Then initializes the buffer with the supplied bytes
`ByteArrayPrimitiveBuilder(java.nio.charset.Charset defaultCharset)` Construct the ByteArrayPrimitiveBuilder with the supplied character set with the default initial size and allocation size determined by that character set
`ByteArrayPrimitiveBuilder(int initialSize)` Construct the ByteArrayPrimitiveBuilder with the supplied initial size, allocation size of and the character set `StandardCharsets.US_ASCII`
`ByteArrayPrimitiveBuilder(int initialSize, java.nio.charset.Charset defaultCharset)` Construct the ByteArrayPrimitiveBuilder with the supplied initial size and character set with the allocation size determined by that character set.
`ByteArrayPrimitiveBuilder(int initialSize, int allocationSizeSuggestion, java.nio.charset.Charset defaultCharset)` Construct the ByteArrayPrimitiveBuilder with the supplied initial size, allocation size and character set

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteArrayPrimitiveBuilder`	`append(byte b)` Append a byte as is
`ByteArrayPrimitiveBuilder`	`append(byte[] src)` Append an entire byte array
`ByteArrayPrimitiveBuilder`	`append(byte[] src, int len)` Append len bytes from the start of byte array
`ByteArrayPrimitiveBuilder`	`append(byte[] src, int index, int len)` Append a byte array
`ByteArrayPrimitiveBuilder`	`append(ByteArrayPrimitiveBuilder bab)` Appends the data bytes from an existing byte array primitive builder
`ByteArrayPrimitiveBuilder`	`append(java.nio.CharBuffer src)` Append a CharBuffer with default charset.
`ByteArrayPrimitiveBuilder`	`append(java.nio.CharBuffer src, java.nio.charset.Charset charset)` Append a CharBuffer with specified charset.
`ByteArrayPrimitiveBuilder`	`append(int i)` Append a String representation of the number.
`ByteArrayPrimitiveBuilder`	`append(java.lang.String src)` Append a String with the default charset.
`ByteArrayPrimitiveBuilder`	`append(java.lang.String src, java.nio.charset.Charset charset)` Append a String with specified charset.
`int`	`appendUnchecked(byte b)` Append a single byte without checking that the builder has the capacity
`int`	`appendUnchecked(byte[] src)` Append the entire byte array without checking that the builder has the capacity
`int`	`appendUnchecked(byte[] src, int srcPos, int len)` Append the entire byte array without checking that the builder has the capacity
`int`	`capacity()` Get the number of bytes currently allocated (available) without resizing
`ByteArrayPrimitiveBuilder`	`clear()` Clear the buffer, resetting its length but not capacity
`int`	`copyTo(byte[] dest, int destPos)` Copy the contents of the buffer to the byte array starting at the destination positions supplied.
`void`	`copyTo(java.io.OutputStream out)` Copy the contents of the buffer to the output stream
`void`	`ensureCapacity(int bytesNeeded)` Ensures that the buffer can accept the number of bytes needed by resizing if necessary.
`boolean`	`equals(byte[] bytes)` Determine if a byte array contains the same bytes as this builder
`byte[]`	`internalArray()` Access the internal byte array of this buffer.
`int`	`length()` Get the length of the data in the buffer
`void`	`setAllocationSize(int allocationSizeSuggestion)` 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 io.nats.client.support.BuilderBase
_setAllocationSize, bufferAllocSize, getAllocationSize

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

- Constructor Detail
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(int initialSize,
                                 int allocationSizeSuggestion,
                                 java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayPrimitiveBuilder with the supplied initial size, allocation size and character set
    
    Parameters:
    
    initialSize - the initial size
    
    allocationSizeSuggestion - the allocationSize size suggestion
    
    defaultCharset - the default character set
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder()
```
    Construct the ByteArrayPrimitiveBuilder with the initial size and allocation size of and the character set StandardCharsets.US_ASCII
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(int initialSize)
```
    Construct the ByteArrayPrimitiveBuilder with the supplied initial size, allocation size of and the character set StandardCharsets.US_ASCII
    
    Parameters:
    
    initialSize - the initial size
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayPrimitiveBuilder with the supplied character set with the default initial size and allocation size determined by that character set
    
    Parameters:
    
    defaultCharset - the default character set
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(int initialSize,
                                 java.nio.charset.Charset defaultCharset)
```
    Construct the ByteArrayPrimitiveBuilder 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
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(byte[] bytes)
```
    Construct the ByteArrayPrimitiveBuilder copying all the bytes using the character set StandardCharsets.US_ASCII Then initializes the buffer with the supplied bytes
    
    Parameters:
    
    bytes - the bytes
  - ByteArrayPrimitiveBuilder
```
public ByteArrayPrimitiveBuilder(byte[] bytes,
                                 int len)
```
    Construct the ByteArrayPrimitiveBuilder copying the specified number of bytes; and the character set StandardCharsets.US_ASCII Then initializes the buffer with the supplied bytes
    
    Parameters:
    
    bytes - the bytes
    
    len - the number of bytes to copy
- Method Detail
  - length
```
public int length()
```
    Get the length of the data in the buffer
    
    Specified by:
    
    length in class BuilderBase
    
    Returns:
    
    the length of the data
  - capacity
```
public int capacity()
```
    Get the number of bytes currently allocated (available) without resizing
    
    Specified by:
    
    capacity in class BuilderBase
    
    Returns:
    
    the number of bytes
  - equals
```
public boolean equals(byte[] bytes)
```
    Determine if a byte array contains the same bytes as this builder
    
    Specified by:
    
    equals in class BuilderBase
    
    Parameters:
    
    bytes - the bytes
    
    Returns:
    
    true if the supplied value equals what is in the builder
  - 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 position 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
  - copyTo
```
public void copyTo(java.io.OutputStream out)
            throws java.io.IOException
```
    Copy the contents of the buffer to the output stream
    
    Parameters:
    
    out - the output stream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - toByteArray
```
public byte[] toByteArray()
```
    Copy the value in the buffer to a new byte array
    
    Specified by:
    
    toByteArray in class BuilderBase
    
    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()
    
    Specified by:
    
    internalArray in class BuilderBase
    
    Returns:
    
    a direct handle to the internal byte array
  - ensureCapacity
```
public void ensureCapacity(int bytesNeeded)
```
    Ensures that the buffer can accept the number of bytes needed by resizing if necessary. Useful if the size of multiple append operations is known ahead of time, reducing the number of resizes
    
    Parameters:
    
    bytesNeeded - the number of bytes needed
  - clear
```
public ByteArrayPrimitiveBuilder clear()
```
    Clear the buffer, resetting its length but not capacity
    
    Returns:
    
    this (fluent)
  - setAllocationSize
```
public void setAllocationSize(int allocationSizeSuggestion)
```
    Change the allocation size
    
    Parameters:
    
    allocationSizeSuggestion - the new allocation size suggestion
  - append
```
public ByteArrayPrimitiveBuilder append(int i)
```
    Append a String representation of the number.
    
    Parameters:
    
    i - the number
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayPrimitiveBuilder 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 ByteArrayPrimitiveBuilder 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 ByteArrayPrimitiveBuilder 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 ByteArrayPrimitiveBuilder 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 ByteArrayPrimitiveBuilder append(byte b)
```
    Append a byte as is
    
    Parameters:
    
    b - the byte
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayPrimitiveBuilder append(byte[] src)
```
    Append an entire byte array
    
    Parameters:
    
    src - The array from which bytes are to be read
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayPrimitiveBuilder append(byte[] src,
                                        int len)
```
    Append len bytes from the start of 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
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayPrimitiveBuilder append(byte[] src,
                                        int index,
                                        int len)
```
    Append a byte array
    
    Parameters:
    
    src - The array from which bytes are to be read
    
    index - The index in the array of the first byte to be read;
    
    len - The number of bytes to be read from the given array;
    
    Returns:
    
    this (fluent)
  - append
```
public ByteArrayPrimitiveBuilder append(ByteArrayPrimitiveBuilder bab)
```
    Appends the data bytes from an existing byte array primitive builder
    
    Parameters:
    
    bab - an existing builder
    
    Returns:
    
    this (fluent)
  - appendUnchecked
```
public int appendUnchecked(byte b)
```
    Append a single byte without checking that the builder has the capacity
    
    Specified by:
    
    appendUnchecked in class BuilderBase
    
    Parameters:
    
    b - the byte
    
    Returns:
    
    the number of bytes appended, always 1
  - appendUnchecked
```
public int appendUnchecked(byte[] src)
```
    Append the entire byte array without checking that the builder has the capacity
    
    Specified by:
    
    appendUnchecked in class BuilderBase
    
    Parameters:
    
    src - the source byte array
    
    Returns:
    
    the number of bytes appended
  - appendUnchecked
```
public int appendUnchecked(byte[] src,
                           int srcPos,
                           int len)
```
    Append the entire byte array without checking that the builder has the capacity
    
    Specified by:
    
    appendUnchecked in class BuilderBase
    
    Parameters:
    
    src - the source byte array
    
    srcPos - starting position in the source array.
    
    len - the number of array elements to be copied.
    
    Returns:
    
    the number of bytes appended
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ByteArrayPrimitiveBuilder

Field Summary

Fields inherited from class io.nats.client.support.BuilderBase

Constructor Summary

Method Summary

Methods inherited from class io.nats.client.support.BuilderBase

Methods inherited from class java.lang.Object

Constructor Detail

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

ByteArrayPrimitiveBuilder

Method Detail

length

capacity

equals

copyTo

copyTo

toByteArray

internalArray

ensureCapacity

clear

setAllocationSize

append

append

append

append

append

append

append

append

append

append

appendUnchecked

appendUnchecked

appendUnchecked

toString