SnapshotWriter (Copycat API Reference (1.1.4))

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`SnapshotWriter`	`flush()`
`SnapshotWriter`	`write(Buffer buffer)`
`SnapshotWriter`	`write(byte[] bytes)`
`SnapshotWriter`	`write(byte[] bytes, long offset, long length)`
`SnapshotWriter`	`write(Bytes bytes)`
`SnapshotWriter`	`write(Bytes bytes, long offset, long 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)`
`SnapshotWriter`	`writeObject(Object object)` Writes an object to the snapshot.
`SnapshotWriter`	`writeShort(short s)`
`SnapshotWriter`	`writeString(String s)`
`SnapshotWriter`	`writeUnsignedByte(int b)`
`SnapshotWriter`	`writeUnsignedInt(long i)`
`SnapshotWriter`	`writeUnsignedMedium(int m)`
`SnapshotWriter`	`writeUnsignedShort(int s)`
`SnapshotWriter`	`writeUTF8(String s)`

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

All Implemented Interfaces:

BufferOutput<SnapshotWriter>, AutoCloseable
```
public class SnapshotWriter
extends Object
implements 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) 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()
  
  SnapshotWriter flush()
  
  SnapshotWriter write(Buffer buffer)
  
  SnapshotWriter write(byte[] bytes)
  
  SnapshotWriter write(byte[] bytes, long offset, long length)
  
  SnapshotWriter write(Bytes bytes)
  
  SnapshotWriter write(Bytes bytes, long offset, long 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)
  
  SnapshotWriter writeObject(Object object)
  Writes an object to the snapshot.
  
  SnapshotWriter writeShort(short s)
  
  SnapshotWriter writeString(String s)
  
  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

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

Class SnapshotWriter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

writeObject

write

write

write

write

write

writeByte

writeUnsignedByte

writeChar

writeShort

writeUnsignedShort

writeMedium

writeUnsignedMedium

writeInt

writeUnsignedInt

writeLong

writeFloat

writeDouble

writeBoolean

writeString

writeUTF8

flush

close