BreadthFirstTrace (Oak Segment Tar 1.22.13 API)

java.lang.Object
- org.apache.jackrabbit.oak.segment.tool.iotrace.BreadthFirstTrace

All Implemented Interfaces:

Trace
```
public class BreadthFirstTrace
extends Object
implements Trace
```
A breadth first traversal trace.
When run this trace performs a breadth first traversal starting from the passed node down to a certain depth. It logs the current depth and the number of traversed nodes as additional context.

Field Summary

Fields
Modifier and Type Field Description

static @NotNull String CONTEXT_SPEC
The context specification of this trace.

Constructor Summary

Constructors
Constructor	Description
`BreadthFirstTrace(int depth, @NotNull String path, @NotNull Consumer<List<String>> context)`	Create a new instance of a breadth first traversal trace.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`run(@NotNull org.apache.jackrabbit.oak.spi.state.NodeState node)`	Run this trace on the passed `node`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONTEXT_SPEC
```
@NotNull
public static final @NotNull String CONTEXT_SPEC
```
    The context specification of this trace.
    
    See Also:
    
    IOTracer.newIOTracer(Function, Writer, String), Constant Field Values
- Constructor Detail
  - BreadthFirstTrace
```
public BreadthFirstTrace(int depth,
                         @NotNull
                         @NotNull String path,
                         @NotNull
                         @NotNull Consumer<List<String>> context)
```
    Create a new instance of a breadth first traversal trace.
    
    Parameters:
    
    depth - maximal depth of the nodes to traverse
    
    path - path of the root node where to start traversing
    
    context - consumer to pass the additional context to
- Method Detail
  - run
```
public void run(@NotNull
                @NotNull org.apache.jackrabbit.oak.spi.state.NodeState node)
```
    Description copied from interface: Trace
    
    Run this trace on the passed node.
    
    Specified by:
    
    run in interface Trace