SegmentedJournal (Atomix API Reference (2.1.0-beta1))

Nested Classes
Modifier and Type	Class and Description
`static class`	`SegmentedJournal.Builder<E>` Segmented journal builder.

Constructors
Constructor and Description
`SegmentedJournal(String name, StorageLevel storageLevel, File directory, io.atomix.utils.serializer.Serializer serializer, int maxSegmentSize, int maxEntriesPerSegment)`

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> SegmentedJournal.Builder<E>`	`builder()` Returns a new segmented journal builder.
`void`	`close()`
`void`	`compact(long index)` Compacts the journal up to the given index.
`File`	`directory()` Returns the storage directory.
`long`	`getCompactableIndex(long index)` Returns the index of the last segment in the log.
`boolean`	`isCompactable(long index)` Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.
`boolean`	`isOpen()` Returns a boolean indicating whether the journal is open.
`int`	`maxEntriesPerSegment()` Returns the maximum number of entries per segment.
`int`	`maxSegmentSize()` Returns the maximum journal segment size.
`String`	`name()` Returns the segment file name prefix.
`SegmentedJournalReader<E>`	`openReader(long index)` Opens a new journal reader.
`StorageLevel`	`storageLevel()` Returns the storage level.
`SegmentedJournalWriter<E>`	`writer()` Returns the journal writer.

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

All Implemented Interfaces:

Journal<E>, Closeable, AutoCloseable
```
public class SegmentedJournal<E>
extends Object
implements Journal<E>
```
Segmented journal implementation.
Author:
- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class and Description
  
  static class SegmentedJournal.Builder<E>
  Segmented journal builder.
  
  Constructor Summary
  
  Constructors
  Constructor and Description
  
  SegmentedJournal(String name, StorageLevel storageLevel, File directory, io.atomix.utils.serializer.Serializer serializer, int maxSegmentSize, int maxEntriesPerSegment)
  
  Method Summary
  
  All Methods Static Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  static <E> SegmentedJournal.Builder<E> builder()
  Returns a new segmented journal builder.
  
  void close()
  
  void compact(long index)
  Compacts the journal up to the given index.
  
  File directory()
  Returns the storage directory.
  
  long getCompactableIndex(long index)
  Returns the index of the last segment in the log.
  
  boolean isCompactable(long index)
  Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.
  
  boolean isOpen()
  Returns a boolean indicating whether the journal is open.
  
  int maxEntriesPerSegment()
  Returns the maximum number of entries per segment.
  
  int maxSegmentSize()
  Returns the maximum journal segment size.
  
  String name()
  Returns the segment file name prefix.
  
  SegmentedJournalReader<E> openReader(long index)
  Opens a new journal reader.
  
  StorageLevel storageLevel()
  Returns the storage level.
  
  SegmentedJournalWriter<E> writer()
  Returns the journal writer.
  
  Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SegmentedJournal
```
public SegmentedJournal(String name,
                        StorageLevel storageLevel,
                        File directory,
                        io.atomix.utils.serializer.Serializer serializer,
                        int maxSegmentSize,
                        int maxEntriesPerSegment)
```
- Method Detail
  - builder
```
public static <E> SegmentedJournal.Builder<E> builder()
```
    Returns a new segmented journal builder.
    
    Returns:
    
    A new segmented journal builder.
  - name
```
public String name()
```
    Returns the segment file name prefix.
    
    Returns:
    
    The segment file name prefix.
  - directory
```
public File directory()
```
    Returns the storage directory.
    The storage directory is the directory to which all segments write files. Segment files for multiple logs may be stored in the storage directory, and files for each log instance will be identified by the prefix provided when the log is opened.
    
    Returns:
    
    The storage directory.
  - storageLevel
```
public StorageLevel storageLevel()
```
    Returns the storage level.
    The storage level dictates how entries within individual journal segments should be stored.
    
    Returns:
    
    The storage level.
  - maxSegmentSize
```
public int maxSegmentSize()
```
    Returns the maximum journal segment size.
    The maximum segment size dictates the maximum size any segment in a segment may consume in bytes.
    
    Returns:
    
    The maximum segment size in bytes.
  - maxEntriesPerSegment
```
public int maxEntriesPerSegment()
```
    Returns the maximum number of entries per segment.
    The maximum entries per segment dictates the maximum number of entries that are allowed to be stored in any segment in a journal.
    
    Returns:
    
    The maximum number of entries per segment.
  - writer
```
public SegmentedJournalWriter<E> writer()
```
    Description copied from interface: Journal
    
    Returns the journal writer.
    
    Specified by:
    
    writer in interface Journal<E>
    
    Returns:
    
    The journal writer.
  - openReader
```
public SegmentedJournalReader<E> openReader(long index)
```
    Description copied from interface: Journal
    
    Opens a new journal reader.
    
    Specified by:
    
    openReader in interface Journal<E>
    
    Parameters:
    
    index - The index at which to start the reader.
    
    Returns:
    
    A new journal reader.
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Journal
    
    Returns a boolean indicating whether the journal is open.
    
    Specified by:
    
    isOpen in interface Journal<E>
    
    Returns:
    
    Indicates whether the journal is open.
  - isCompactable
```
public boolean isCompactable(long index)
```
    Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.
    
    Parameters:
    
    index - the index from which to remove segments
    
    Returns:
    
    indicates whether a segment can be removed from the journal
  - getCompactableIndex
```
public long getCompactableIndex(long index)
```
    Returns the index of the last segment in the log.
    
    Parameters:
    
    index - the compaction index
    
    Returns:
    
    the starting index of the last segment in the log
  - compact
```
public void compact(long index)
```
    Compacts the journal up to the given index.
    The semantics of compaction are not specified by this interface.
    
    Parameters:
    
    index - The index up to which to compact the journal.
  - close
```
public void close()
```
    Specified by:
    
    close in interface Journal<E>
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class SegmentedJournal<E>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SegmentedJournal

Method Detail

builder

name

directory

storageLevel

maxSegmentSize

maxEntriesPerSegment

writer

openReader

isOpen

isCompactable

getCompactableIndex

compact

close