CircularBuffer (sshj 0.38.0 API)

java.lang.Object
- net.schmizz.sshj.common.CircularBuffer<T>

Direct Known Subclasses:: CircularBuffer.PlainCircularBuffer

public class CircularBuffer<T extends CircularBuffer<T>>
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CircularBuffer.CircularBufferException

static class CircularBuffer.PlainCircularBuffer

Constructor Summary

Constructors
Constructor Description

CircularBuffer(int size, int maxSize)
Creates a new circular buffer of the given size.

Method Summary

Modifier and Type	Method	Description
`int`	`available()`	Data available in the buffer for reading.
`int`	`maxPossibleRemainingCapacity()`	Returns how many more bytes this buffer can receive.
`T`	`putRawBytes(byte[] source, int offset, int length)`	Writes data to this buffer from the provided array.
`void`	`readRawBytes(byte[] destination, int offset, int length)`	Reads data from this buffer into the provided array.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - CircularBuffer
```
public CircularBuffer(int size,
                      int maxSize)
```
    Creates a new circular buffer of the given size. The capacity of the buffer is one less than the size/
- Method Detail
  - available
```
public int available()
```
    Data available in the buffer for reading.
  - maxPossibleRemainingCapacity
```
public int maxPossibleRemainingCapacity()
```
    Returns how many more bytes this buffer can receive.
  - readRawBytes
```
public void readRawBytes(byte[] destination,
                         int offset,
                         int length)
                  throws CircularBuffer.CircularBufferException
```
    Reads data from this buffer into the provided array.
    
    Throws:
    
    CircularBuffer.CircularBufferException
  - putRawBytes
```
public T putRawBytes(byte[] source,
                     int offset,
                     int length)
              throws CircularBuffer.CircularBufferException
```
    Writes data to this buffer from the provided array.
    
    Throws:
    
    CircularBuffer.CircularBufferException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object