org.apache.jackrabbit.oak.util

Class NodeUtil

java.lang.Object

org.apache.jackrabbit.oak.util.NodeUtil

public class NodeUtil
extends Object

Utility class for accessing and writing typed content of a tree.

Constructor Summary

Constructors

Constructor and Description
NodeUtil(Tree tree)
NodeUtil(Tree tree, NameMapper mapper)

Method Summary

Methods

Modifier and Type	Method and Description
NodeUtil	addChild(String name, String primaryTypeName) Adds a new child tree with the given name and primary type name.
NodeUtil	getChild(String name)
long	getLong(String name, long defaultValue)
String	getName()
String	getName(String name, String defaultValue)
NodeUtil	getOrAddChild(String name, String primaryTypeName) Combination of getChild(String) and addChild(String, String) in case no tree exists with the specified name.
NodeUtil	getOrAddTree(String relativePath, String primaryTypeName) TODO: clean up.
NodeUtil	getParent()
String	getString(String name, String defaultValue)
Tree	getTree()
boolean	hasChild(String name)
void	removeProperty(String name)
void	setBoolean(String name, boolean value)
void	setDate(String name, long time)
void	setName(String propertyName, String value)
void	setNames(String propertyName, String... values)
void	setString(String name, String value)
void	setStrings(String name, String... values)
void	setValues(String name, Value[] values)

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeUtil

public NodeUtil(Tree tree,
        NameMapper mapper)

NodeUtil

public NodeUtil(Tree tree)

Method Detail

getTree

public Tree getTree()

getName

public String getName()

getParent

public NodeUtil getParent()

hasChild

public boolean hasChild(String name)

getChild

public NodeUtil getChild(String name)

addChild

public NodeUtil addChild(String name,
                String primaryTypeName)
                  throws AccessDeniedException

Adds a new child tree with the given name and primary type name. This method is a shortcut for calling Tree.addChild(String) and Tree.setProperty(String, Object, org.apache.jackrabbit.oak.api.Type) where the property name is JcrConstants.JCR_PRIMARYTYPE. Note, that this method in addition verifies if the created tree exists and is accessible in order to avoid IllegalStateException upon subsequent modification of the new child.

Parameters:

name - The name of the child item.

primaryTypeName - The name of the primary node type.

Returns:

The new child node with the specified name and primary type.

Throws:

AccessDeniedException - If the child does not exist after creation.

getOrAddChild

public NodeUtil getOrAddChild(String name,
                     String primaryTypeName)
                       throws AccessDeniedException

Combination of getChild(String) and addChild(String, String) in case no tree exists with the specified name.

Parameters:

name - The name of the child item.

primaryTypeName - The name of the primary node type.

Returns:

The new child node with the specified name and primary type.

Throws:

AccessDeniedException - If the child does not exist after creation.

getOrAddTree

public NodeUtil getOrAddTree(String relativePath,
                    String primaryTypeName)
                      throws AccessDeniedException

TODO: clean up. workaround for OAK-426

Create the tree at the specified relative path including all missing intermediate trees using the specified primaryTypeName. This method treats ".." parent element and "." as current element and resolves them accordingly; in case of a relative path containing parent elements this may lead to tree creating outside the tree structure defined by this NodeUtil.

Parameters:

relativePath - A relative OAK path that may contain parent and current elements.

primaryTypeName - A oak name of a primary node type that is used to create the missing trees.

Returns:

The node util of the tree at the specified relativePath.

Throws:

AccessDeniedException - If the any intermediate tree does not exist and cannot be created.

removeProperty

public void removeProperty(String name)

setBoolean

public void setBoolean(String name,
              boolean value)

getString

public String getString(String name,
               String defaultValue)

setString

public void setString(String name,
             String value)

setStrings

public void setStrings(String name,
              String... values)

getName

public String getName(String name,
             String defaultValue)

setName

public void setName(String propertyName,
           String value)

setNames

public void setNames(String propertyName,
            String... values)

setDate

public void setDate(String name,
           long time)

getLong

public long getLong(String name,
           long defaultValue)

setValues

public void setValues(String name,
             Value[] values)