com.squareup.tape2

Class QueueFile.Builder

java.lang.Object

com.squareup.tape2.QueueFile.Builder

Enclosing class:

QueueFile

public static final class QueueFile.Builder
extends java.lang.Object

Fluent API for creating QueueFile instances.

Constructor Summary

Constructors

Constructor and Description
Builder(java.io.File file) Start constructing a new queue backed by the given file.

Method Summary

Modifier and Type	Method and Description
QueueFile	build() Constructs a new queue backed by the given builder.
QueueFile.Builder	forceLegacy(boolean forceLegacy) When true, only the legacy (Tape 1.x) format will be used.
QueueFile.Builder	zero(boolean zero) When true, removing an element will also overwrite data with zero bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.io.File file)

Start constructing a new queue backed by the given file.

Method Detail

zero

public QueueFile.Builder zero(boolean zero)

When true, removing an element will also overwrite data with zero bytes.

forceLegacy

public QueueFile.Builder forceLegacy(boolean forceLegacy)

When true, only the legacy (Tape 1.x) format will be used.

build

public QueueFile build()
                throws java.io.IOException

Constructs a new queue backed by the given builder. Only one instance should access a given file at a time.

Throws:

java.io.IOException