Package org.apache.jackrabbit.oak.segment.tool

Class Backup.Builder

java.lang.Object

org.apache.jackrabbit.oak.segment.tool.Backup.Builder

Enclosing class:

Backup

public static class Backup.Builder
extends Object

Collect options for the Backup command.

Method Summary

Modifier and Type	Method	Description
Backup	build()	Create an executable version of the Backup command.
Backup.Builder	withFakeBlobStore(boolean fakeBlobStore)	Simulate the existence of a file-based blob store.
Backup.Builder	withSource(File source)	The source folder of the backup.
Backup.Builder	withTarget(File target)	The target folder of the backup.

Methods inherited from class java.lang.Object

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

Method Details

withSource

public Backup.Builder withSource(File source)

The source folder of the backup. This parameter is required. The path should point to a valid segment store.

Parameters:

source - the path of the source folder of the backup.

Returns:

this builder.

withTarget

public Backup.Builder withTarget(File target)

The target folder of the backup. This parameter is required. The path should point to an existing segment store or to an empty folder. If the folder doesn't exist, it will be created.

Parameters:

target - the path of the target folder of the backup.

Returns:

this builder.

withFakeBlobStore

public Backup.Builder withFakeBlobStore(boolean fakeBlobStore)

Simulate the existence of a file-based blob store. This parameter is not required and defaults to false.

Parameters:

fakeBlobStore - true if a file-based blob store should be simulated, false otherwise.

Returns:

this builder.

build

public Backup build()

Create an executable version of the Backup command.

Returns:

an instance of Runnable.