org.rundeck.storage.conf

Class TreeBuilder<T extends org.rundeck.storage.api.ContentMeta>

java.lang.Object

org.rundeck.storage.conf.TreeBuilder<T>

public class TreeBuilder<T extends org.rundeck.storage.api.ContentMeta>
extends java.lang.Object

Builder for Resource Trees. Allows extending a base tree with other trees at sub paths. Content converters and listeners can be added selectively to sub paths, or based on analyzing the content.

Method Summary

Modifier and Type	Method and Description
TreeBuilder<T>	base(org.rundeck.storage.api.Tree<T> base) Set the base tree to be extended
org.rundeck.storage.api.Tree<T>	build() Build the tree
static <T extends org.rundeck.storage.api.ContentMeta> TreeBuilder<T>	builder() Build a new tree with an empty base
static <T extends org.rundeck.storage.api.ContentMeta> TreeBuilder<T>	builder(org.rundeck.storage.api.Tree<T> base) Build a new tree with given base
TreeBuilder<T>	convert(ContentConverter<T> converter) Convert all content in the tree
TreeBuilder<T>	convert(ContentConverter<T> converter, org.rundeck.storage.api.Path path) Convert data content for all resources below the given path
TreeBuilder<T>	convert(ContentConverter<T> converter, org.rundeck.storage.api.Path subpath, org.rundeck.storage.api.ResourceSelector<T> resourceSelector) Convert data content for all resources matching the resource selector and within the sub path
TreeBuilder<T>	convert(ContentConverter<T> converter, org.rundeck.storage.api.PathSelector selector) Convert data content for all resource paths matched by the path selector
TreeBuilder<T>	convert(ContentConverter<T> converter, org.rundeck.storage.api.PathSelector pathSelector, org.rundeck.storage.api.ResourceSelector<T> resourceSelector) Convert data content for all resources matching the resource selector and the path selector
TreeBuilder<T>	convert(ContentConverter<T> converter, org.rundeck.storage.api.ResourceSelector<T> selector) Convert data content for all resources matching the selector
TreeBuilder<T>	listen(Listener<T> listener) Listen to events on all paths of the tree
TreeBuilder<T>	listen(Listener<T> listener, org.rundeck.storage.api.Path subpath) Listen to events on selective paths of the tree
TreeBuilder<T>	listen(Listener<T> listener, org.rundeck.storage.api.PathSelector pathSelector) Listen to events on selective paths of the tree
TreeBuilder<T>	subTree(org.rundeck.storage.api.Path path, org.rundeck.storage.api.Tree<T> subtree, boolean fullPath) Add a tree responsible for a subpath of the base tree.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <T extends org.rundeck.storage.api.ContentMeta> TreeBuilder<T> builder()

Build a new tree with an empty base

Type Parameters:

T - content type

Returns:

builder

builder

public static <T extends org.rundeck.storage.api.ContentMeta> TreeBuilder<T> builder(org.rundeck.storage.api.Tree<T> base)

Build a new tree with given base

Type Parameters:

T - content type

Parameters:

base - base tree

Returns:

builder

base

public TreeBuilder<T> base(org.rundeck.storage.api.Tree<T> base)

Set the base tree to be extended

Parameters:

base - base tree

Returns:

builder

subTree

public TreeBuilder<T> subTree(org.rundeck.storage.api.Path path,
                              org.rundeck.storage.api.Tree<T> subtree,
                              boolean fullPath)

Add a tree responsible for a subpath of the base tree.

Parameters:

path - sub path to handle

subtree - tree to delegate to for the path

fullPath - if true, send resources to the subtree with the original full path, otherwise store with a path relative to the path

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter,
                              org.rundeck.storage.api.Path path)

Convert data content for all resources below the given path

Parameters:

converter - content converter

path - sub path to convert data

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter,
                              org.rundeck.storage.api.PathSelector selector)

Convert data content for all resource paths matched by the path selector

Parameters:

converter - content converter

selector - path selection

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter,
                              org.rundeck.storage.api.ResourceSelector<T> selector)

Convert data content for all resources matching the selector

Parameters:

converter - content converter

selector - resource selector

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter,
                              org.rundeck.storage.api.Path subpath,
                              org.rundeck.storage.api.ResourceSelector<T> resourceSelector)

Convert data content for all resources matching the resource selector and within the sub path

Parameters:

converter - content converter

subpath - sub path

resourceSelector - resource selector

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter,
                              org.rundeck.storage.api.PathSelector pathSelector,
                              org.rundeck.storage.api.ResourceSelector<T> resourceSelector)

Convert data content for all resources matching the resource selector and the path selector

Parameters:

converter - content converter

pathSelector - path selector

resourceSelector - resource selector

Returns:

builder

convert

public TreeBuilder<T> convert(ContentConverter<T> converter)

Convert all content in the tree

Parameters:

converter - converter

Returns:

builder

listen

public TreeBuilder<T> listen(Listener<T> listener)

Listen to events on all paths of the tree

Parameters:

listener - listener

Returns:

builder

listen

public TreeBuilder<T> listen(Listener<T> listener,
                             org.rundeck.storage.api.PathSelector pathSelector)

Listen to events on selective paths of the tree

Parameters:

listener - listener

pathSelector - path selector

Returns:

builder

listen

public TreeBuilder<T> listen(Listener<T> listener,
                             org.rundeck.storage.api.Path subpath)

Listen to events on selective paths of the tree

Parameters:

listener - listener

subpath - sub path

Returns:

builder

build

public org.rundeck.storage.api.Tree<T> build()

Build the tree

Returns:

the tree