SnapshotWriter (Atomix API Reference (2.0.4))

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

All Implemented Interfaces:

io.atomix.storage.buffer.BufferOutput<SnapshotWriter>, AutoCloseable
```
public class SnapshotWriter
extends Object
implements io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
```
Writes bytes to a state machine Snapshot.
This class provides the primary interface for writing snapshot buffers to disk or memory. Snapshot bytes are written to an underlying Buffer which is backed by either memory or disk based on the configured StorageLevel.
In addition to standard BufferOutput methods, snapshot readers support writing serializable objects to the snapshot via the writeObject(Object, 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()`
`SnapshotWriter`	`flush()`
`Snapshot`	`snapshot()` Returns the snapshot associated with the writer.
`SnapshotWriter`	`write(io.atomix.storage.buffer.Buffer buffer)`
`SnapshotWriter`	`write(byte[] bytes)`
`SnapshotWriter`	`write(byte[] bytes, int offset, int length)`
`SnapshotWriter`	`write(io.atomix.storage.buffer.Bytes bytes)`
`SnapshotWriter`	`write(io.atomix.storage.buffer.Bytes bytes, int offset, int length)`
`SnapshotWriter`	`writeBoolean(boolean b)`
`SnapshotWriter`	`writeByte(int b)`
`SnapshotWriter`	`writeChar(char c)`
`SnapshotWriter`	`writeDouble(double d)`
`SnapshotWriter`	`writeFloat(float f)`
`SnapshotWriter`	`writeInt(int i)`
`SnapshotWriter`	`writeLong(long l)`
`SnapshotWriter`	`writeMedium(int m)`
`<T> SnapshotWriter`	`writeObject(T object, com.google.common.base.Function<T,byte[]> encoder)` Writes an object to the snapshot.
`SnapshotWriter`	`writeShort(short s)`
`SnapshotWriter`	`writeString(String s)`
`SnapshotWriter`	`writeString(String s, Charset charset)`
`SnapshotWriter`	`writeUnsignedByte(int b)`
`SnapshotWriter`	`writeUnsignedInt(long i)`
`SnapshotWriter`	`writeUnsignedMedium(int m)`
`SnapshotWriter`	`writeUnsignedShort(int s)`
`SnapshotWriter`	`writeUTF8(String s)`

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

Methods inherited from interface io.atomix.storage.buffer.BufferOutput
writeBytes

- Method Detail
  - snapshot
```
public Snapshot snapshot()
```
    Returns the snapshot associated with the writer.
    
    Returns:
    
    The snapshot associated with the writer
  - writeObject
```
public <T> SnapshotWriter writeObject(T object,
                                      com.google.common.base.Function<T,byte[]> encoder)
```
    Writes an object to the snapshot.
    
    Parameters:
    
    object - the object to write
    
    encoder - the object encoder
    
    Returns:
    
    The snapshot writer.
  - write
```
public SnapshotWriter write(io.atomix.storage.buffer.Bytes bytes)
```
    Specified by:
    
    write in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - write
```
public SnapshotWriter write(byte[] bytes)
```
    Specified by:
    
    write in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - write
```
public SnapshotWriter write(io.atomix.storage.buffer.Bytes bytes,
                            int offset,
                            int length)
```
    Specified by:
    
    write in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - write
```
public SnapshotWriter write(byte[] bytes,
                            int offset,
                            int length)
```
    Specified by:
    
    write in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - write
```
public SnapshotWriter write(io.atomix.storage.buffer.Buffer buffer)
```
    Specified by:
    
    write in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeByte
```
public SnapshotWriter writeByte(int b)
```
    Specified by:
    
    writeByte in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeUnsignedByte
```
public SnapshotWriter writeUnsignedByte(int b)
```
    Specified by:
    
    writeUnsignedByte in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeChar
```
public SnapshotWriter writeChar(char c)
```
    Specified by:
    
    writeChar in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeShort
```
public SnapshotWriter writeShort(short s)
```
    Specified by:
    
    writeShort in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeUnsignedShort
```
public SnapshotWriter writeUnsignedShort(int s)
```
    Specified by:
    
    writeUnsignedShort in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeMedium
```
public SnapshotWriter writeMedium(int m)
```
    Specified by:
    
    writeMedium in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeUnsignedMedium
```
public SnapshotWriter writeUnsignedMedium(int m)
```
    Specified by:
    
    writeUnsignedMedium in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeInt
```
public SnapshotWriter writeInt(int i)
```
    Specified by:
    
    writeInt in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeUnsignedInt
```
public SnapshotWriter writeUnsignedInt(long i)
```
    Specified by:
    
    writeUnsignedInt in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeLong
```
public SnapshotWriter writeLong(long l)
```
    Specified by:
    
    writeLong in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeFloat
```
public SnapshotWriter writeFloat(float f)
```
    Specified by:
    
    writeFloat in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeDouble
```
public SnapshotWriter writeDouble(double d)
```
    Specified by:
    
    writeDouble in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeBoolean
```
public SnapshotWriter writeBoolean(boolean b)
```
    Specified by:
    
    writeBoolean in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeString
```
public SnapshotWriter writeString(String s)
```
    Specified by:
    
    writeString in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeString
```
public SnapshotWriter writeString(String s,
                                  Charset charset)
```
    Specified by:
    
    writeString in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - writeUTF8
```
public SnapshotWriter writeUTF8(String s)
```
    Specified by:
    
    writeUTF8 in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - flush
```
public SnapshotWriter flush()
```
    Specified by:
    
    flush in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
  - close
```
public void close()
```
    Specified by:
    
    close in interface io.atomix.storage.buffer.BufferOutput<SnapshotWriter>
    
    Specified by:
    
    close in interface AutoCloseable

Class SnapshotWriter

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

snapshot

writeObject

write

write

write

write

write

writeByte

writeUnsignedByte

writeChar

writeShort

writeUnsignedShort

writeMedium

writeUnsignedMedium

writeInt

writeUnsignedInt

writeLong

writeFloat

writeDouble

writeBoolean

writeString

writeString

writeUTF8

flush

close