org.infobip.lib.popout

Class FileQueueBuilder<T>

java.lang.Object

org.infobip.lib.popout.FileQueueBuilder<T>

public final class FileQueueBuilder<T>
extends Object

FileQueue builder. The only one way to instantiate FileQueue.

Since:

1.0.0

Author:

Artem Labazin

See Also:

FileQueue

Constructor Summary

Constructors

Constructor and Description
FileQueueBuilder()

Method Summary

Modifier and Type	Method and Description
FileQueue<T>	build() Builds FileQueue instance.
FileQueueBuilder<T>	deserializer(Deserializer<T> elementsDeserializer) Sets elements deserializer, during read operations.
FileQueueBuilder<T>	fileMmapEnable() Enables using mmap file feature for speeding up write/read operations.
FileQueueBuilder<T>	fileMmapEnable(int bufferSizeBytes) Enables using mmap file feature for speeding up write/read operations.
FileQueueBuilder<T>	filePattern(FilePattern pattern) Sets queue files pattern.
FileQueueBuilder<T>	filePattern(String pattern) Sets queue files pattern.
FileQueueBuilder<T>	maxFileSizeBytes(long size) Sets queue file's maximum size in bytes.
FileQueueBuilder<T>	metadataFile(Path path) Sets path to metadata file, which contains information about the queue.
FileQueueBuilder<T>	metadataFile(String metadataFilePath) Sets path to metadata file, which contains information about the queue.
FileQueueBuilder<T>	serializer(Serializer<T> elementsSerializer) Sets elements serializer, during write operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileQueueBuilder

public FileQueueBuilder()

Method Detail

metadataFile

public FileQueueBuilder<T> metadataFile(@NonNull
                                        String metadataFilePath)

Sets path to metadata file, which contains information about the queue.

Parameters:

metadataFilePath - path to metadata file

Returns:

this builder

metadataFile

public FileQueueBuilder<T> metadataFile(@NonNull
                                        Path path)

Sets path to metadata file, which contains information about the queue.

Parameters:

path - path to metadata file

Returns:

this builder

filePattern

public FileQueueBuilder<T> filePattern(@NonNull
                                       String pattern)

Sets queue files pattern.

Default is "batch-#.queue", where '#' sign is for file's index.

Parameters:

pattern - string queue's files pattern representation

Returns:

this builder

filePattern

public FileQueueBuilder<T> filePattern(@NonNull
                                       FilePattern pattern)

Sets queue files pattern.

Default is "batch-#.queue", where '#' sign is for file's index.

Parameters:

pattern - queue's files pattern

Returns:

this builder

maxFileSizeBytes

public FileQueueBuilder<T> maxFileSizeBytes(long size)

Sets queue file's maximum size in bytes.

Default is 100Mb

Parameters:

size - the maximum size of queue file in bytes

Returns:

this builder

fileMmapEnable

public FileQueueBuilder<T> fileMmapEnable()

Enables using mmap file feature for speeding up write/read operations.

Default mmap file buffer size is 8Kb.

Returns:

this builder

fileMmapEnable

public FileQueueBuilder<T> fileMmapEnable(int bufferSizeBytes)

Enables using mmap file feature for speeding up write/read operations.

Also it allows to setup mmap file buffer.

Default mmap file buffer size is 8Kb.

Parameters:

bufferSizeBytes - mmap file buffer size in bytes

Returns:

this builder

serializer

public FileQueueBuilder<T> serializer(@NonNull
                                      Serializer<T> elementsSerializer)

Sets elements serializer, during write operations.

Default using implementation is DefaultSerializer

Parameters:

elementsSerializer - elements serializer

Returns:

this builder

deserializer

public FileQueueBuilder<T> deserializer(@NonNull
                                        Deserializer<T> elementsDeserializer)

Sets elements deserializer, during read operations.

Default using implementation is DefaultDeserializer

Parameters:

elementsDeserializer - elements deserializer

Returns:

this builder

build

public FileQueue<T> build()

Builds FileQueue instance.

Returns:

FileQueue instance