org.apache.jackrabbit.oak.segment.tool

Class History.Builder

java.lang.Object

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

Enclosing class:

History

public static class History.Builder
extends Object

Collect options for the History command.

Method Summary

Modifier and Type	Method and Description
History	build() Create an executable version of the History command.
History.Builder	withDepth(int depth) Maximum depth of the history.
History.Builder	withJournal(File journal) The path to the journal.
History.Builder	withNode(String node) A path to a node.
History.Builder	withPath(File path) The path to an existing segment store.

Methods inherited from class java.lang.Object

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

Method Detail

withPath

public History.Builder withPath(File path)

The path to an existing segment store. This parameter is required.

Parameters:

path - the path to an existing segment store.

Returns:

this builder.

withJournal

public History.Builder withJournal(File journal)

The path to the journal. This parameter is required.

Parameters:

journal - the path to the journal.

Returns:

this builder.

withNode

public History.Builder withNode(String node)

A path to a node. If specified, the history will be restricted to the subtree pointed to by this node. This parameter is not mandatory and defaults to the entire tree.

Parameters:

node - a path to a node.

Returns:

this builder.

withDepth

public History.Builder withDepth(int depth)

Maximum depth of the history. If specified, this command will print information about the history of every node at or below the provided depth. This parameter is not mandatory and defaults to zero.

Parameters:

depth - the depth of the subtree.

Returns:

this builder.

build

public History build()

Create an executable version of the History command.

Returns:

an instance of History.