io.atomix.storage.journal

Class SegmentedJournal.Builder<E>

java.lang.Object

io.atomix.storage.journal.SegmentedJournal.Builder<E>

All Implemented Interfaces:

io.atomix.utils.Builder<SegmentedJournal<E>>

Enclosing class:

SegmentedJournal<E>

public static class SegmentedJournal.Builder<E>
extends Object
implements io.atomix.utils.Builder<SegmentedJournal<E>>

Segmented journal builder.

Method Summary

Modifier and Type	Method and Description
SegmentedJournal<E>	build() Builds the journal.
SegmentedJournal.Builder<E>	withDirectory(File directory) Sets the log directory, returning the builder for method chaining.
SegmentedJournal.Builder<E>	withDirectory(String directory) Sets the log directory, returning the builder for method chaining.
SegmentedJournal.Builder<E>	withMaxEntriesPerSegment(int maxEntriesPerSegment) Sets the maximum number of allows entries per segment, returning the builder for method chaining.
SegmentedJournal.Builder<E>	withMaxSegmentSize(int maxSegmentSize) Sets the maximum segment size in bytes, returning the builder for method chaining.
SegmentedJournal.Builder<E>	withName(String name) Sets the storage name.
SegmentedJournal.Builder<E>	withSerializer(io.atomix.utils.serializer.Serializer serializer) Sets the journal serializer, returning the builder for method chaining.
SegmentedJournal.Builder<E>	withStorageLevel(StorageLevel storageLevel) Sets the log storage level, returning the builder for method chaining.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withName

public SegmentedJournal.Builder<E> withName(String name)

Sets the storage name.

Parameters:

name - The storage name.

Returns:

The storage builder.

withStorageLevel

public SegmentedJournal.Builder<E> withStorageLevel(StorageLevel storageLevel)

Sets the log storage level, returning the builder for method chaining.

The storage level indicates how individual entries should be persisted in the journal.

Parameters:

storageLevel - The log storage level.

Returns:

The storage builder.

withDirectory

public SegmentedJournal.Builder<E> withDirectory(String directory)

Sets the log directory, returning the builder for method chaining.

The log will write segment files into the provided directory.

Parameters:

directory - The log directory.

Returns:

The storage builder.

Throws:

NullPointerException - If the directory is null

withDirectory

public SegmentedJournal.Builder<E> withDirectory(File directory)

Sets the log directory, returning the builder for method chaining.

The log will write segment files into the provided directory.

Parameters:

directory - The log directory.

Returns:

The storage builder.

Throws:

NullPointerException - If the directory is null

withSerializer

public SegmentedJournal.Builder<E> withSerializer(io.atomix.utils.serializer.Serializer serializer)

Sets the journal serializer, returning the builder for method chaining.

Parameters:

serializer - The journal serializer.

Returns:

The journal builder.

withMaxSegmentSize

public SegmentedJournal.Builder<E> withMaxSegmentSize(int maxSegmentSize)

Sets the maximum segment size in bytes, returning the builder for method chaining.

The maximum segment size dictates when logs should roll over to new segments. As entries are written to a segment of the log, once the size of the segment surpasses the configured maximum segment size, the log will create a new segment and append new entries to that segment.

By default, the maximum segment size is 1024 * 1024 * 32.

Parameters:

maxSegmentSize - The maximum segment size in bytes.

Returns:

The storage builder.

Throws:

IllegalArgumentException - If the maxSegmentSize is not positive

withMaxEntriesPerSegment

public SegmentedJournal.Builder<E> withMaxEntriesPerSegment(int maxEntriesPerSegment)

Sets the maximum number of allows entries per segment, returning the builder for method chaining.

The maximum entry count dictates when logs should roll over to new segments. As entries are written to a segment of the log, if the entry count in that segment meets the configured maximum entry count, the log will create a new segment and append new entries to that segment.

By default, the maximum entries per segment is 1024 * 1024.

Parameters:

maxEntriesPerSegment - The maximum number of entries allowed per segment.

Returns:

The storage builder.

Throws:

IllegalArgumentException - If the maxEntriesPerSegment not greater than the default max entries per segment

build

public SegmentedJournal<E> build()

Builds the journal.

Specified by:

build in interface io.atomix.utils.Builder<SegmentedJournal<E>>

Returns:

The built storage configuration.