CircularBuffer

java.lang.Object
- org.apache.commons.compress.archivers.zip.CircularBuffer

class CircularBuffer
extends java.lang.Object

Circular byte buffer.

Since:: 1.7

Field Summary

Fields
Modifier and Type	Field	Description
`private byte[]`	`buffer`	The buffer
`private int`	`readIndex`	Index of the next data to be read from the buffer
`private int`	`size`	Size of the buffer
`private int`	`writeIndex`	Index of the next data written in the buffer

Constructor Summary

Constructors
Constructor Description

CircularBuffer(int size)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`available()`	Tells if a new byte can be read from the buffer.
`void`	`copy(int distance, int length)`	Copy a previous interval in the buffer to the current position.
`int`	`get()`	Reads a byte from the buffer.
`void`	`put(int value)`	Writes a byte to the buffer.

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

- Field Detail
  - size
```
private final int size
```
    Size of the buffer
  - buffer
```
private final byte[] buffer
```
    The buffer
  - readIndex
```
private int readIndex
```
    Index of the next data to be read from the buffer
  - writeIndex
```
private int writeIndex
```
    Index of the next data written in the buffer
- Constructor Detail
  - CircularBuffer
```
CircularBuffer(int size)
```
- Method Detail
  - available
```
public boolean available()
```
    Tells if a new byte can be read from the buffer.
  - put
```
public void put(int value)
```
    Writes a byte to the buffer.
  - get
```
public int get()
```
    Reads a byte from the buffer.
  - copy
```
public void copy(int distance,
                 int length)
```
    Copy a previous interval in the buffer to the current position.
    
    Parameters:
    
    distance - the distance from the current write position
    
    length - the number of bytes to copy