ByteArrayBuffer (Apache Mina SSHD

java.lang.Object
- org.apache.sshd.common.util.buffer.Buffer
- - org.apache.sshd.common.util.buffer.ByteArrayBuffer

All Implemented Interfaces:

Readable

Direct Known Subclasses:

SessionWorkBuffer
```
public class ByteArrayBuffer
extends Buffer
```
Provides an implementation of Buffer using a backing byte array

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_SIZE

static int MAX_LEN
- Fields inherited from class org.apache.sshd.common.util.buffer.Buffer
  workBuf

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SIZE`
`static int`	`MAX_LEN`

Constructor Summary

Constructors
Constructor and Description
`ByteArrayBuffer()`
`ByteArrayBuffer(byte[] data)`
`ByteArrayBuffer(byte[] data, boolean read)`
`ByteArrayBuffer(byte[] data, int off, int len)`
`ByteArrayBuffer(byte[] data, int off, int len, boolean read)`
`ByteArrayBuffer(int size)`
`ByteArrayBuffer(int size, boolean roundOff)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`array()`
`int`	`available()`
`int`	`capacity()`
`void`	`clear(boolean wipeData)`
`void`	`compact()`
`protected void`	`copyRawBytes(int offset, byte[] buf, int pos, int len)`
`void`	`ensureCapacity(int capacity, IntUnaryOperator growthFactor)`
`byte`	`getByte()`
`static ByteArrayBuffer`	`getCompactClone(byte[] data)` Creates a compact buffer (i.e., one that starts at offset zero) containing a copy of the original data
`static ByteArrayBuffer`	`getCompactClone(byte[] data, int offset, int len)` Creates a compact buffer (i.e., one that starts at offset zero) containing a copy of the original data
`void`	`getRawBytes(byte[] buf, int off, int len)`
`String`	`getString(Charset charset)`
`void`	`putBuffer(ByteBuffer buffer)`
`int`	`putBuffer(Readable buffer, boolean expand)`
`void`	`putByte(byte b)`
`void`	`putRawBytes(byte[] d, int off, int len)`
`int`	`rpos()`
`void`	`rpos(int rpos)`
`protected int`	`size()`
`int`	`wpos()`
`void`	`wpos(int wpos)`

Methods inherited from class org.apache.sshd.common.util.buffer.Buffer
clear, dumpHex, dumpHex, ensureAvailable, ensureCapacity, extractEC, getAvailableStrings, getAvailableStrings, getBoolean, getBytes, getCompactData, getInt, getKeyPair, getLong, getMPInt, getMPIntAsBytes, getPublicKey, getPublicKey, getRawBytes, getRawPublicKey, getRawPublicKey, getShort, getString, getStringList, getStringList, getStringList, getStringList, getUByte, getUInt, isValidMessageStructure, isValidMessageStructure, putAndWipeBytes, putAndWipeBytes, putAndWipeChars, putAndWipeChars, putAndWipeChars, putAndWipeChars, putBoolean, putBuffer, putBytes, putBytes, putChars, putChars, putChars, putChars, putInt, putKeyPair, putLong, putMPInt, putMPInt, putPublicKey, putRawBytes, putRawPublicKey, putShort, putString, putString, putStringList, putStringList, toHex, toString

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

Methods inherited from interface org.apache.sshd.common.util.Readable
readable

- Field Detail
  - DEFAULT_SIZE
```
public static final int DEFAULT_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_LEN
```
public static final int MAX_LEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ByteArrayBuffer
```
public ByteArrayBuffer()
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(int size)
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(int size,
                       boolean roundOff)
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(byte[] data)
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(byte[] data,
                       boolean read)
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(byte[] data,
                       int off,
                       int len)
```
  - ByteArrayBuffer
```
public ByteArrayBuffer(byte[] data,
                       int off,
                       int len,
                       boolean read)
```
- Method Detail
  - rpos
```
public int rpos()
```
    Specified by:
    
    rpos in class Buffer
  - rpos
```
public void rpos(int rpos)
```
    Specified by:
    
    rpos in class Buffer
  - wpos
```
public int wpos()
```
    Specified by:
    
    wpos in class Buffer
  - wpos
```
public void wpos(int wpos)
```
    Specified by:
    
    wpos in class Buffer
  - available
```
public int available()
```
  - capacity
```
public int capacity()
```
    Specified by:
    
    capacity in class Buffer
  - array
```
public byte[] array()
```
    Specified by:
    
    array in class Buffer
  - compact
```
public void compact()
```
    Specified by:
    
    compact in class Buffer
  - clear
```
public void clear(boolean wipeData)
```
    Specified by:
    
    clear in class Buffer
  - getByte
```
public byte getByte()
```
    Overrides:
    
    getByte in class Buffer
  - putByte
```
public void putByte(byte b)
```
    Overrides:
    
    putByte in class Buffer
  - putBuffer
```
public int putBuffer(Readable buffer,
                     boolean expand)
```
    Specified by:
    
    putBuffer in class Buffer
  - putBuffer
```
public void putBuffer(ByteBuffer buffer)
```
    Specified by:
    
    putBuffer in class Buffer
  - putRawBytes
```
public void putRawBytes(byte[] d,
                        int off,
                        int len)
```
    Specified by:
    
    putRawBytes in class Buffer
  - getString
```
public String getString(Charset charset)
```
    Specified by:
    
    getString in class Buffer
  - getRawBytes
```
public void getRawBytes(byte[] buf,
                        int off,
                        int len)
```
  - copyRawBytes
```
protected void copyRawBytes(int offset,
                            byte[] buf,
                            int pos,
                            int len)
```
    Specified by:
    
    copyRawBytes in class Buffer
  - ensureCapacity
```
public void ensureCapacity(int capacity,
                           IntUnaryOperator growthFactor)
```
    Specified by:
    
    ensureCapacity in class Buffer
    
    Parameters:
    
    capacity - The requires capacity
    
    growthFactor - An IntUnaryOperator that is invoked if the current capacity is insufficient. The argument is the minimum required new data length, the function result should be the effective new data length to be allocated - if less than minimum then an exception is thrown
  - size
```
protected int size()
```
    Specified by:
    
    size in class Buffer
  - getCompactClone
```
public static ByteArrayBuffer getCompactClone(byte[] data)
```
    Creates a compact buffer (i.e., one that starts at offset zero) containing a copy of the original data
    
    Parameters:
    
    data - The original data buffer
    
    Returns:
    
    A ByteArrayBuffer containing a copy of the original data starting at zero read position
    
    See Also:
    
    getCompactClone(byte[], int, int)
  - getCompactClone
```
public static ByteArrayBuffer getCompactClone(byte[] data,
                                              int offset,
                                              int len)
```
    Creates a compact buffer (i.e., one that starts at offset zero) containing a copy of the original data
    
    Parameters:
    
    data - The original data buffer
    
    offset - The offset of the valid data in the buffer
    
    len - The size (in bytes) of of the valid data in the buffer
    
    Returns:
    
    A ByteArrayBuffer containing a copy of the original data starting at zero read position

Class ByteArrayBuffer

Field Summary

Fields inherited from class org.apache.sshd.common.util.buffer.Buffer

Constructor Summary

Method Summary

Methods inherited from class org.apache.sshd.common.util.buffer.Buffer

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.sshd.common.util.Readable

Field Detail

DEFAULT_SIZE

MAX_LEN

Constructor Detail

ByteArrayBuffer

ByteArrayBuffer

ByteArrayBuffer

ByteArrayBuffer

ByteArrayBuffer

ByteArrayBuffer

ByteArrayBuffer

Method Detail

rpos

rpos

wpos

wpos

available

capacity

array

compact

clear

getByte

putByte

putBuffer

putBuffer

putRawBytes

getString

getRawBytes

copyRawBytes

ensureCapacity

size

getCompactClone

getCompactClone