JournalSegmentWriter (Atomix API Reference (2.1.0-beta1))

Constructors
Constructor and Description
`JournalSegmentWriter(JournalSegmentDescriptor descriptor, io.atomix.utils.serializer.Serializer serializer)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(Indexed<E> entry)` Appends an indexed entry to the log.
`<T extends E> Indexed<T>`	`append(T entry)` Appends an entry to the journal.
`void`	`close()`
`long`	`firstIndex()` Returns the first index written to the segment.
`void`	`flush()` Flushes written entries to disk.
`Indexed<E>`	`getLastEntry()` Returns the last entry written.
`long`	`getLastIndex()` Returns the last written index.
`long`	`getNextIndex()` Returns the next index to be written.
`boolean`	`isEmpty()` Returns a boolean indicating whether the segment is empty.
`boolean`	`isFull()` Returns a boolean indicating whether the segment is full.
`long`	`size()` Returns the size of the underlying buffer.
`void`	`truncate(long index)` Truncates the log to the given index.

java.lang.Object
- io.atomix.storage.journal.JournalSegmentWriter<E>

All Implemented Interfaces:

JournalWriter<E>, AutoCloseable
```
public class JournalSegmentWriter<E>
extends Object
implements JournalWriter<E>
```
Segment writer.
The format of an entry in the log is as follows:
- 64-bit index
- 8-bit boolean indicating whether a term change is contained in the entry
- 64-bit optional term
- 32-bit signed entry length, including the entry type ID
- 8-bit signed entry type ID
- n-bit entry bytes
Author:
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  JournalSegmentWriter(JournalSegmentDescriptor descriptor, io.atomix.utils.serializer.Serializer serializer)
  
  Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  void append(Indexed<E> entry)
  Appends an indexed entry to the log.
  
  <T extends E> Indexed<T> append(T entry)
  Appends an entry to the journal.
  
  void close()
  
  long firstIndex()
  Returns the first index written to the segment.
  
  void flush()
  Flushes written entries to disk.
  
  Indexed<E> getLastEntry()
  Returns the last entry written.
  
  long getLastIndex()
  Returns the last written index.
  
  long getNextIndex()
  Returns the next index to be written.
  
  boolean isEmpty()
  Returns a boolean indicating whether the segment is empty.
  
  boolean isFull()
  Returns a boolean indicating whether the segment is full.
  
  long size()
  Returns the size of the underlying buffer.
  
  void truncate(long index)
  Truncates the log to the given index.
  
  Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JournalSegmentWriter
```
public JournalSegmentWriter(JournalSegmentDescriptor descriptor,
                            io.atomix.utils.serializer.Serializer serializer)
```
- Method Detail
  - getLastIndex
```
public long getLastIndex()
```
    Description copied from interface: JournalWriter
    
    Returns the last written index.
    
    Specified by:
    
    getLastIndex in interface JournalWriter<E>
    
    Returns:
    
    The last written index.
  - getLastEntry
```
public Indexed<E> getLastEntry()
```
    Description copied from interface: JournalWriter
    
    Returns the last entry written.
    
    Specified by:
    
    getLastEntry in interface JournalWriter<E>
    
    Returns:
    
    The last entry written.
  - getNextIndex
```
public long getNextIndex()
```
    Description copied from interface: JournalWriter
    
    Returns the next index to be written.
    
    Specified by:
    
    getNextIndex in interface JournalWriter<E>
    
    Returns:
    
    The next index to be written.
  - size
```
public long size()
```
    Returns the size of the underlying buffer.
    
    Returns:
    
    The size of the underlying buffer.
  - isEmpty
```
public boolean isEmpty()
```
    Returns a boolean indicating whether the segment is empty.
    
    Returns:
    
    Indicates whether the segment is empty.
  - isFull
```
public boolean isFull()
```
    Returns a boolean indicating whether the segment is full.
    
    Returns:
    
    Indicates whether the segment is full.
  - firstIndex
```
public long firstIndex()
```
    Returns the first index written to the segment.
  - append
```
public void append(Indexed<E> entry)
```
    Description copied from interface: JournalWriter
    
    Appends an indexed entry to the log.
    
    Specified by:
    
    append in interface JournalWriter<E>
    
    Parameters:
    
    entry - The indexed entry to append.
  - append
```
public <T extends E> Indexed<T> append(T entry)
```
    Description copied from interface: JournalWriter
    
    Appends an entry to the journal.
    
    Specified by:
    
    append in interface JournalWriter<E>
    
    Parameters:
    
    entry - The entry to append.
    
    Returns:
    
    The appended indexed entry.
  - truncate
```
public void truncate(long index)
```
    Description copied from interface: JournalWriter
    
    Truncates the log to the given index.
    
    Specified by:
    
    truncate in interface JournalWriter<E>
    
    Parameters:
    
    index - The index to which to truncate the log.
  - flush
```
public void flush()
```
    Description copied from interface: JournalWriter
    
    Flushes written entries to disk.
    
    Specified by:
    
    flush in interface JournalWriter<E>
  - close
```
public void close()
```
    Specified by:
    
    close in interface JournalWriter<E>
    
    Specified by:
    
    close in interface AutoCloseable

Class JournalSegmentWriter<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JournalSegmentWriter

Method Detail

getLastIndex

getLastEntry

getNextIndex

size

isEmpty

isFull

firstIndex

append

append

truncate

flush

close