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

Class DebugSegments.Builder

java.lang.Object

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

Enclosing class:

DebugSegments

public static class DebugSegments.Builder
extends Object

Collect options for the DebugSegments command.

Method Summary

Modifier and Type	Method	Description
DebugSegments	build()	Create an executable version of the DebugSegments command.
DebugSegments.Builder	withPath(File path)	The path to an existing segment store.
DebugSegments.Builder	withSegment(String segment)	Add a segment, node record or node record range.

Methods inherited from class java.lang.Object

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

Method Detail

withPath

public DebugSegments.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.

withSegment

public DebugSegments.Builder withSegment(String segment)

Add a segment, node record or node record range. It is mandatory to add at least one of a segment, node record or node record range.

A segment is specified by its ID, which is specified as a sequence of hexadecimal digits and dashes. In example, 333dc24d-438f-4cca-8b21-3ebf67c05856.

A node record is specified by its identifier, with an optional path. In example, 333dc24d-438f-4cca-8b21-3ebf67c05856:12345/path/to/child. If a path is not specified, it is take to be /. The command will print information about the node provided by record ID and about every child identified by the path.

A node range record is specified by two node identifiers separated by a dash. In example, 333dc24d-438f-4cca-8b21-3ebf67c05856:12345-46116fda-7a72-4dbc-af88-a09322a7753a:67890. The command will perform a diff between the two records and print the result in the JSOP format.

Parameters:

segment - The specification for a segment, a node record or a node record range.

Returns:

this builder.

build

public DebugSegments build()

Create an executable version of the DebugSegments command.

Returns:

an instance of Runnable.