SnapshotReader (Copycat API Reference (1.1.4))

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`boolean`	`hasRemaining()`
`SnapshotReader`	`read(Buffer buffer)`
`SnapshotReader`	`read(byte[] bytes)`
`SnapshotReader`	`read(byte[] bytes, long offset, long length)`
`SnapshotReader`	`read(Bytes bytes)`
`SnapshotReader`	`read(Bytes bytes, long offset, long length)`
`boolean`	`readBoolean()`
`int`	`readByte()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`int`	`readInt()`
`long`	`readLong()`
`int`	`readMedium()`
`<T> T`	`readObject()` Reads an object from the buffer.
`short`	`readShort()`
`String`	`readString()`
`int`	`readUnsignedByte()`
`long`	`readUnsignedInt()`
`int`	`readUnsignedMedium()`
`int`	`readUnsignedShort()`
`String`	`readUTF8()`
`long`	`remaining()`
`SnapshotReader`	`skip(long bytes)`

java.lang.Object
- io.atomix.copycat.server.storage.snapshot.SnapshotReader

All Implemented Interfaces:

BufferInput<SnapshotReader>, AutoCloseable
```
public class SnapshotReader
extends Object
implements 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() method. Serializable types must be registered on the CopycatServer serializer to be supported in snapshots.
Author:
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  void close()
  
  boolean hasRemaining()
  
  SnapshotReader read(Buffer buffer)
  
  SnapshotReader read(byte[] bytes)
  
  SnapshotReader read(byte[] bytes, long offset, long length)
  
  SnapshotReader read(Bytes bytes)
  
  SnapshotReader read(Bytes bytes, long offset, long length)
  
  boolean readBoolean()
  
  int readByte()
  
  char readChar()
  
  double readDouble()
  
  float readFloat()
  
  int readInt()
  
  long readLong()
  
  int readMedium()
  
  <T> T readObject()
  Reads an object from the buffer.
  
  short readShort()
  
  String readString()
  
  int readUnsignedByte()
  
  long readUnsignedInt()
  
  int readUnsignedMedium()
  
  int readUnsignedShort()
  
  String readUTF8()
  
  long remaining()
  
  SnapshotReader skip(long bytes)
  
  Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class SnapshotReader

Method Summary

Methods inherited from class java.lang.Object

Method Detail

remaining

hasRemaining

skip

readObject

read

read

read

read

read

readByte

readUnsignedByte

readChar

readShort

readUnsignedShort

readMedium

readUnsignedMedium

readInt

readUnsignedInt

readLong

readFloat

readDouble

readBoolean

readString

readUTF8

close