org.apache.jackrabbit.oak.upgrade.tree

Class AbstractMutableTree

java.lang.Object

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

org.apache.jackrabbit.oak.upgrade.tree.AbstractMutableTree

All Implemented Interfaces:

org.apache.jackrabbit.oak.api.Tree

Direct Known Subclasses:

NodeBuilderTree

public abstract class AbstractMutableTree
extends org.apache.jackrabbit.oak.plugins.tree.AbstractTree

AbstractMutableTree extends AbstractTree with implementations for most write methods of Tree. Furthermore it handles the ordering of siblings.

Nested Class Summary

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

org.apache.jackrabbit.oak.api.Tree.Status

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.plugins.tree.AbstractTree

name, nodeBuilder

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

EMPTY_ARRAY, GET_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMutableTree(String name, org.apache.jackrabbit.oak.spi.state.NodeBuilder nodeBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.jackrabbit.oak.api.Tree	addChild(String name)
org.apache.jackrabbit.oak.api.Tree	getChild(String name)
protected abstract org.apache.jackrabbit.oak.spi.state.NodeBuilder	getNodeBuilder()
AbstractMutableTree	getParent()
protected abstract AbstractMutableTree	getParentOrNull()
boolean	orderBefore(String name)
boolean	remove()
void	removeProperty(String name)
void	setOrderableChildren(boolean enable)
void	setProperty(org.apache.jackrabbit.oak.api.PropertyState property)
<T> void	setProperty(String name, T value)
<T> void	setProperty(String name, T value, org.apache.jackrabbit.oak.api.Type<T> type)
protected void	updateChildOrder(boolean force) Updates the child order to match any added or removed child nodes that are not yet reflected in the TreeConstants.OAK_CHILD_ORDER property.

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

buildPath, createChild, exists, getChildNames, getChildren, getChildrenCount, getName, getNodeState, getPath, getProperties, getProperty, getPropertyCount, getPropertyStatus, getStatus, hasChild, hasOrderableChildren, hasProperty, isModified, isNew, isRoot, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMutableTree

protected AbstractMutableTree(@Nonnull
                   String name,
                   @Nonnull
                   org.apache.jackrabbit.oak.spi.state.NodeBuilder nodeBuilder)

Method Detail

getParentOrNull

protected abstract AbstractMutableTree getParentOrNull()

getNodeBuilder

protected abstract org.apache.jackrabbit.oak.spi.state.NodeBuilder getNodeBuilder()

getParent

@Nonnull
public AbstractMutableTree getParent()

Specified by:

getParent in interface org.apache.jackrabbit.oak.api.Tree

Overrides:

getParent in class org.apache.jackrabbit.oak.plugins.tree.AbstractTree

getChild

@Nonnull
public org.apache.jackrabbit.oak.api.Tree getChild(@Nonnull
                                                  String name)
                                            throws IllegalArgumentException

Throws:

IllegalArgumentException

remove

public boolean remove()

addChild

@Nonnull
public org.apache.jackrabbit.oak.api.Tree addChild(@Nonnull
                                                  String name)
                                            throws IllegalArgumentException

Throws:

IllegalArgumentException

setOrderableChildren

public void setOrderableChildren(boolean enable)

updateChildOrder

protected void updateChildOrder(boolean force)

Updates the child order to match any added or removed child nodes that are not yet reflected in the TreeConstants.OAK_CHILD_ORDER property. If the force flag is set, the child order is set in any case, otherwise only if the node already is orderable.

Parameters:

force - whether to add child order information if it doesn't exist

orderBefore

public boolean orderBefore(@Nullable
                  String name)

setProperty

public void setProperty(@Nonnull
               org.apache.jackrabbit.oak.api.PropertyState property)

setProperty

public <T> void setProperty(@Nonnull
                   String name,
                   @Nonnull
                   T value)
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

setProperty

public <T> void setProperty(@Nonnull
                   String name,
                   @Nonnull
                   T value,
                   @Nonnull
                   org.apache.jackrabbit.oak.api.Type<T> type)
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

removeProperty

public void removeProperty(@Nonnull
                  String name)