SnapshotReader (Atomix API Reference (2.0.4))

java.lang.Object
- io.atomix.protocols.raft.storage.snapshot.SnapshotReader

All Implemented Interfaces:

io.atomix.storage.buffer.BufferInput<SnapshotReader>, AutoCloseable
```
public class SnapshotReader
extends Object
implements io.atomix.storage.buffer.BufferInput<SnapshotReader>
```
Reads bytes from a state machine Snapshot.
This class provides the primary interface for reading snapshot buffers from disk or memory. Snapshot bytes are read from an underlying Buffer which is backed by either memory or disk based on the configured StorageLevel.
In addition to standard BufferInput methods, snapshot readers support reading serializable objects from the snapshot via the readObject(Function) method. Serializable types must be registered on the RaftServer serializer to be supported in snapshots.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`boolean`	`hasRemaining()`
`int`	`position()`
`SnapshotReader`	`read(io.atomix.storage.buffer.Buffer buffer)`
`SnapshotReader`	`read(byte[] bytes)`
`SnapshotReader`	`read(byte[] bytes, int offset, int length)`
`SnapshotReader`	`read(io.atomix.storage.buffer.Bytes bytes)`
`SnapshotReader`	`read(io.atomix.storage.buffer.Bytes bytes, int offset, int length)`
`boolean`	`readBoolean()`
`int`	`readByte()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`int`	`readInt()`
`long`	`readLong()`
`int`	`readMedium()`
`<T> T`	`readObject(com.google.common.base.Function<byte[],T> decoder)` Reads an object from the buffer.
`short`	`readShort()`
`String`	`readString()`
`String`	`readString(Charset charset)`
`int`	`readUnsignedByte()`
`long`	`readUnsignedInt()`
`int`	`readUnsignedMedium()`
`int`	`readUnsignedShort()`
`String`	`readUTF8()`
`int`	`remaining()`
`SnapshotReader`	`skip(int bytes)`
`Snapshot`	`snapshot()` Returns the snapshot associated with the reader.

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

Methods inherited from interface io.atomix.storage.buffer.BufferInput
readBytes

- Method Detail
  - snapshot
```
public Snapshot snapshot()
```
    Returns the snapshot associated with the reader.
    
    Returns:
    
    The snapshot associated with the reader
  - position
```
public int position()
```
    Specified by:
    
    position in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - remaining
```
public int remaining()
```
    Specified by:
    
    remaining in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - hasRemaining
```
public boolean hasRemaining()
```
    Specified by:
    
    hasRemaining in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - skip
```
public SnapshotReader skip(int bytes)
```
    Specified by:
    
    skip in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readObject
```
public <T> T readObject(com.google.common.base.Function<byte[],T> decoder)
```
    Reads an object from the buffer.
    
    Type Parameters:
    
    T - the type of the object to read
    
    Parameters:
    
    decoder - the object decoder
    
    Returns:
    
    the read object.
  - read
```
public SnapshotReader read(io.atomix.storage.buffer.Bytes bytes)
```
    Specified by:
    
    read in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - read
```
public SnapshotReader read(byte[] bytes)
```
    Specified by:
    
    read in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - read
```
public SnapshotReader read(io.atomix.storage.buffer.Bytes bytes,
                           int offset,
                           int length)
```
    Specified by:
    
    read in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - read
```
public SnapshotReader read(byte[] bytes,
                           int offset,
                           int length)
```
    Specified by:
    
    read in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - read
```
public SnapshotReader read(io.atomix.storage.buffer.Buffer buffer)
```
    Specified by:
    
    read in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readByte
```
public int readByte()
```
    Specified by:
    
    readByte in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readUnsignedByte
```
public int readUnsignedByte()
```
    Specified by:
    
    readUnsignedByte in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readChar
```
public char readChar()
```
    Specified by:
    
    readChar in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readShort
```
public short readShort()
```
    Specified by:
    
    readShort in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readUnsignedShort
```
public int readUnsignedShort()
```
    Specified by:
    
    readUnsignedShort in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readMedium
```
public int readMedium()
```
    Specified by:
    
    readMedium in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readUnsignedMedium
```
public int readUnsignedMedium()
```
    Specified by:
    
    readUnsignedMedium in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readInt
```
public int readInt()
```
    Specified by:
    
    readInt in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readUnsignedInt
```
public long readUnsignedInt()
```
    Specified by:
    
    readUnsignedInt in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readLong
```
public long readLong()
```
    Specified by:
    
    readLong in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readFloat
```
public float readFloat()
```
    Specified by:
    
    readFloat in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readDouble
```
public double readDouble()
```
    Specified by:
    
    readDouble in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readBoolean
```
public boolean readBoolean()
```
    Specified by:
    
    readBoolean in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readString
```
public String readString()
```
    Specified by:
    
    readString in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readString
```
public String readString(Charset charset)
```
    Specified by:
    
    readString in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - readUTF8
```
public String readUTF8()
```
    Specified by:
    
    readUTF8 in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
  - close
```
public void close()
```
    Specified by:
    
    close in interface io.atomix.storage.buffer.BufferInput<SnapshotReader>
    
    Specified by:
    
    close in interface AutoCloseable

Class SnapshotReader

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.atomix.storage.buffer.BufferInput

Method Detail

snapshot

position

remaining

hasRemaining

skip

readObject

read

read

read

read

read

readByte

readUnsignedByte

readChar

readShort

readUnsignedShort

readMedium

readUnsignedMedium

readInt

readUnsignedInt

readLong

readFloat

readDouble

readBoolean

readString

readString

readUTF8

close