org.infobip.lib.popout

Class FileQueue.Builder<SELF extends FileQueue.Builder<SELF,T>,T>

java.lang.Object

org.infobip.lib.popout.FileQueue.Builder<SELF,T>

Type Parameters:

SELF - the type of builder's chain call return type

T - the type of elements in this builded queues

Direct Known Subclasses:

BatchedFileQueueBuilder, SyncedFileQueueBuilder

Enclosing class:

FileQueue<T>

public abstract static class FileQueue.Builder<SELF extends FileQueue.Builder<SELF,T>,T>
extends Object

The abstract file-based queue builder with common options and parameters for all such queues implementations.

Since:

2.0.0

Author:

Artem Labazin

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FileQueue<T>	build() Builds a new queue with parameters from the builder.
SELF	compressed(@NonNull CompressedFilesConfig value) Sets the compression files configuration.
protected abstract FileQueue<T>	createQueue() The method for producing a new queue on each call based on builder's parameters.
SELF	deserializer(@NonNull Deserializer<T> value) Sets the Deserializer implementation for queue elements.
SELF	folder(@NonNull Path value) Sets a queue's folder path, which the queue uses if the WAL and compressed configurations doesn't tell another.
SELF	folder(@NonNull String value) Sets a queue's folder path, which the queue uses if the WAL and compressed configurations doesn't tell another.
SELF	limit(@NonNull QueueLimit<T> value) Sets the queue limits.
SELF	name(@NonNull String value) Sets the queue's name.
SELF	restoreFromDisk(boolean value) Tells to the queue to restore its state from the previous run files or not.
SELF	serializer(@NonNull Serializer<T> value) Sets the Serializer implementation for queue elements.
protected void	validateAndSetDefaults() The method for builder's parameters validation and setting the default values, before creating a new queue.
SELF	wal(@NonNull WalFilesConfig value) Sets the WAL files configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

public SELF name(@NonNull
                 @NonNull String value)

Sets the queue's name. It uses in files names patters.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

folder

public SELF folder(@NonNull
                   @NonNull String value)

Sets a queue's folder path, which the queue uses if the WAL and compressed configurations doesn't tell another.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

folder

public SELF folder(@NonNull
                   @NonNull Path value)

Sets a queue's folder path, which the queue uses if the WAL and compressed configurations doesn't tell another.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

serializer

public SELF serializer(@NonNull
                       @NonNull Serializer<T> value)

Sets the Serializer implementation for queue elements.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

deserializer

public SELF deserializer(@NonNull
                         @NonNull Deserializer<T> value)

Sets the Deserializer implementation for queue elements.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

limit

public SELF limit(@NonNull
                  @NonNull QueueLimit<T> value)

Sets the queue limits.

The default value is an instance of QueueLimit.NoLimit.

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

wal

public SELF wal(@NonNull
                @NonNull WalFilesConfig value)

Sets the WAL files configuration.

The default value has:

• 100 max WAL files amount, before compression
• the folder from the main builder's folder value

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

compressed

public SELF compressed(@NonNull
                       @NonNull CompressedFilesConfig value)

Sets the compression files configuration.

The default value has:

• Long.MAX_VALUE max file size (unlimited, another words)
• the folder from the main builder's folder value

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

restoreFromDisk

public SELF restoreFromDisk(boolean value)

Tells to the queue to restore its state from the previous run files or not.

If it is set to false, the queue, before start, removes all previous run files (if they exist).

If it is set to true, the queue re-reads all the files and restores its state.

The default value is: true

Parameters:

value - the new value

Returns:

this queue builder, for chain calls

build

public FileQueue<T> build()

Builds a new queue with parameters from the builder.

Returns:

a new queue

createQueue

protected abstract FileQueue<T> createQueue()

The method for producing a new queue on each call based on builder's parameters.

Returns:

implementation-specific queue instance

validateAndSetDefaults

protected void validateAndSetDefaults()

The method for builder's parameters validation and setting the default values, before creating a new queue.