Package org.apache.jackrabbit.oak.plugins.tree.impl

Class NodeBuilderTree

java.lang.Object

org.apache.jackrabbit.oak.plugins.tree.impl.AbstractTree

org.apache.jackrabbit.oak.plugins.tree.impl.AbstractMutableTree

org.apache.jackrabbit.oak.plugins.tree.impl.NodeBuilderTree

All Implemented Interfaces:

Tree

public final class NodeBuilderTree
extends AbstractMutableTree

A mutable Tree implementation based on an underlying NodeBuilder, which tracks all changes recorded through this tree's mutator methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.api.Tree

Tree.Status

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.api.Tree

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
	NodeBuilderTree(@NotNull java.lang.String name, @NotNull NodeBuilder nodeBuilder)	Create a new AbstractTree instance
protected	NodeBuilderTree(@Nullable NodeBuilderTree parent, @NotNull NodeBuilder nodeBuilder, @NotNull java.lang.String name)

Method Summary

Modifier and Type	Method	Description
protected @NotNull NodeBuilderTree	createChild(@NotNull java.lang.String name)	Factory method for creating child trees
@NotNull java.lang.String	getName()
protected @NotNull NodeBuilder	getNodeBuilder()
protected @Nullable AbstractMutableTree	getParentOrNull()

Methods inherited from class org.apache.jackrabbit.oak.plugins.tree.impl.AbstractMutableTree

addChild, orderBefore, remove, removeProperty, setOrderableChildren, setProperty, setProperty, setProperty, updateChildOrder

Methods inherited from class org.apache.jackrabbit.oak.plugins.tree.impl.AbstractTree

buildPath, exists, getChild, getChildNames, getChildren, getChildrenCount, getInternalNodeNames, getNodeState, getParent, getPath, getProperties, getProperty, getPropertyCount, getPropertyStatus, getStatus, hasChild, hasOrderableChildren, hasProperty, isHidden, isRoot, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeBuilderTree

public NodeBuilderTree(@NotNull
                       @NotNull java.lang.String name,
                       @NotNull
                       @NotNull NodeBuilder nodeBuilder)

Create a new AbstractTree instance

Parameters:

nodeBuilder - NodeBuilder for the underlying node state

name - name of the tree

NodeBuilderTree

protected NodeBuilderTree(@Nullable
                          @Nullable NodeBuilderTree parent,
                          @NotNull
                          @NotNull NodeBuilder nodeBuilder,
                          @NotNull
                          @NotNull java.lang.String name)

Method Detail

getParentOrNull

@Nullable
protected @Nullable AbstractMutableTree getParentOrNull()

Specified by:

getParentOrNull in class AbstractTree

Returns:

the parent of this tree or null for the root

getNodeBuilder

@NotNull
protected @NotNull NodeBuilder getNodeBuilder()

Specified by:

getNodeBuilder in class AbstractTree

Returns:

The NodeBuilder for the underlying node state

getName

@NotNull
public @NotNull java.lang.String getName()

Returns:

the name of this Tree instance.

createChild

@NotNull
protected @NotNull NodeBuilderTree createChild(@NotNull
                                               @NotNull java.lang.String name)
                                        throws java.lang.IllegalArgumentException

Description copied from class: AbstractTree

Factory method for creating child trees

Specified by:

createChild in class AbstractTree

Parameters:

name - name of the child tree

Returns:

child tree of this tree with the given name

Throws:

java.lang.IllegalArgumentException - if the given name string is empty or contains the forward slash character