org.apache.jackrabbit.oak.plugins.tree

Class TreeUtil

java.lang.Object

org.apache.jackrabbit.oak.plugins.tree.TreeUtil

public final class TreeUtil
extends Object

Utility providing common operations for the Tree that are not provided by the API.

Method Summary

Modifier and Type	Method and Description
static org.apache.jackrabbit.oak.api.Tree	addChild(org.apache.jackrabbit.oak.api.Tree tree, String childName, String primaryTypeName) Adds a new child tree with the given name and primary type name.
static org.apache.jackrabbit.oak.api.Tree	addChild(org.apache.jackrabbit.oak.api.Tree parent, String name, String typeName, org.apache.jackrabbit.oak.api.Tree typeRoot, String userID)
static void	addMixin(org.apache.jackrabbit.oak.api.Tree tree, String mixinName, org.apache.jackrabbit.oak.api.Tree typeRoot, String userID)
static void	autoCreateItems(org.apache.jackrabbit.oak.api.Tree tree, org.apache.jackrabbit.oak.api.Tree type, org.apache.jackrabbit.oak.api.Tree typeRoot, String userID)
static org.apache.jackrabbit.oak.api.PropertyState	autoCreateProperty(String name, org.apache.jackrabbit.oak.api.Tree definition, String userID)
static String	findDefaultPrimaryType(org.apache.jackrabbit.oak.api.Tree definitions, boolean sns)
static boolean	getBoolean(org.apache.jackrabbit.oak.api.Tree tree, String propertyName) Returns the boolean representation of the property with the specified propertyName.
static String	getDefaultChildType(org.apache.jackrabbit.oak.api.Tree typeRoot, org.apache.jackrabbit.oak.api.Tree parent, String childName) Finds the default primary type for a new child node with the given name.
static List<org.apache.jackrabbit.oak.api.Tree>	getEffectiveType(org.apache.jackrabbit.oak.api.Tree tree, org.apache.jackrabbit.oak.api.Tree typeRoot) Returns the effective node types of the given node.
static long	getLong(org.apache.jackrabbit.oak.api.Tree tree, String name, long defaultValue)
static String	getName(org.apache.jackrabbit.oak.api.Tree tree, String name)
static Iterable<String>	getNames(org.apache.jackrabbit.oak.api.Tree tree, String name)
static org.apache.jackrabbit.oak.api.Tree	getOrAddChild(org.apache.jackrabbit.oak.api.Tree tree, String childName, String primaryTypeName) Combination of Tree.getChild(String) and adding a child including its jcr:primaryType property (i.e.
static String	getPrimaryTypeName(org.apache.jackrabbit.oak.api.Tree tree)
static String	getString(org.apache.jackrabbit.oak.api.Tree tree, String propertyName)
static String	getString(org.apache.jackrabbit.oak.api.Tree tree, String name, String defaultValue)
static Iterable<String>	getStrings(org.apache.jackrabbit.oak.api.Tree tree, String propertyName)
static org.apache.jackrabbit.oak.api.Tree	getTree(org.apache.jackrabbit.oak.api.Tree tree, String path) Return the possibly non existing tree located at the passed path from the location of the start tree or null if path results in a parent of the root.
static boolean	isNodeType(org.apache.jackrabbit.oak.api.Tree tree, String typeName, org.apache.jackrabbit.oak.api.Tree typeRoot)
static boolean	isReadOnlyTree(org.apache.jackrabbit.oak.api.Tree tree) Returns true if the specified tree is a read-only tree..

Methods inherited from class java.lang.Object

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

Method Detail

getPrimaryTypeName

@CheckForNull
public static String getPrimaryTypeName(@Nonnull
                                                       org.apache.jackrabbit.oak.api.Tree tree)

getStrings

@CheckForNull
public static Iterable<String> getStrings(@Nonnull
                                                         org.apache.jackrabbit.oak.api.Tree tree,
                                                         @Nonnull
                                                         String propertyName)

getString

@CheckForNull
public static String getString(@Nonnull
                                              org.apache.jackrabbit.oak.api.Tree tree,
                                              @Nonnull
                                              String propertyName)

getString

@CheckForNull
public static String getString(@Nonnull
                                              org.apache.jackrabbit.oak.api.Tree tree,
                                              @Nonnull
                                              String name,
                                              @Nullable
                                              String defaultValue)

getBoolean

public static boolean getBoolean(@Nonnull
                                 org.apache.jackrabbit.oak.api.Tree tree,
                                 @Nonnull
                                 String propertyName)

Returns the boolean representation of the property with the specified propertyName. If the property does not exist or is an array this method returns false.

Parameters:

tree - The target tree.

propertyName - The name of the property.

Returns:

the boolean representation of the property state with the given name. This utility returns false if the property does not exist or is an multivalued property.

getName

@CheckForNull
public static String getName(@Nonnull
                                            org.apache.jackrabbit.oak.api.Tree tree,
                                            @Nonnull
                                            String name)

getNames

@Nonnull
public static Iterable<String> getNames(@Nonnull
                                                  org.apache.jackrabbit.oak.api.Tree tree,
                                                  @Nonnull
                                                  String name)

getLong

public static long getLong(@Nonnull
                           org.apache.jackrabbit.oak.api.Tree tree,
                           @Nonnull
                           String name,
                           long defaultValue)

getTree

@CheckForNull
public static org.apache.jackrabbit.oak.api.Tree getTree(@Nonnull
                                                                        org.apache.jackrabbit.oak.api.Tree tree,
                                                                        @Nonnull
                                                                        String path)

Return the possibly non existing tree located at the passed path from the location of the start tree or null if path results in a parent of the root.

Parameters:

tree - start tree

path - path from the start tree

Returns:

tree located at path from start or null

addChild

public static org.apache.jackrabbit.oak.api.Tree addChild(@Nonnull
                                                          org.apache.jackrabbit.oak.api.Tree parent,
                                                          @Nonnull
                                                          String name,
                                                          @CheckForNull
                                                          String typeName,
                                                          @Nonnull
                                                          org.apache.jackrabbit.oak.api.Tree typeRoot,
                                                          @CheckForNull
                                                          String userID)
                                                   throws RepositoryException

Throws:

RepositoryException

addChild

@Nonnull
public static org.apache.jackrabbit.oak.api.Tree addChild(@Nonnull
                                                                    org.apache.jackrabbit.oak.api.Tree tree,
                                                                    @Nonnull
                                                                    String childName,
                                                                    @Nonnull
                                                                    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:

childName - The Oak name of the child item.

primaryTypeName - The Oak name of the primary node type.

Returns:

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

Throws:

AccessDeniedException - If the child does not exist after creation.

getOrAddChild

@Nonnull
public static org.apache.jackrabbit.oak.api.Tree getOrAddChild(@Nonnull
                                                                         org.apache.jackrabbit.oak.api.Tree tree,
                                                                         @Nonnull
                                                                         String childName,
                                                                         @Nonnull
                                                                         String primaryTypeName)
                                                                  throws AccessDeniedException

Combination of Tree.getChild(String) and adding a child including its jcr:primaryType property (i.e. Tree.addChild(String) and Tree.setProperty(PropertyState)) in case no tree exists with the specified name.

Parameters:

childName - The Oak name of the child item.

primaryTypeName - The Oak 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.

addMixin

public static void addMixin(@Nonnull
                            org.apache.jackrabbit.oak.api.Tree tree,
                            @Nonnull
                            String mixinName,
                            @Nonnull
                            org.apache.jackrabbit.oak.api.Tree typeRoot,
                            @CheckForNull
                            String userID)
                     throws RepositoryException

Throws:

RepositoryException

autoCreateItems

public static void autoCreateItems(@Nonnull
                                   org.apache.jackrabbit.oak.api.Tree tree,
                                   @Nonnull
                                   org.apache.jackrabbit.oak.api.Tree type,
                                   @Nonnull
                                   org.apache.jackrabbit.oak.api.Tree typeRoot,
                                   @CheckForNull
                                   String userID)
                            throws RepositoryException

Throws:

RepositoryException

autoCreateProperty

public static org.apache.jackrabbit.oak.api.PropertyState autoCreateProperty(@Nonnull
                                                                             String name,
                                                                             @Nonnull
                                                                             org.apache.jackrabbit.oak.api.Tree definition,
                                                                             @CheckForNull
                                                                             String userID)

getDefaultChildType

public static String getDefaultChildType(org.apache.jackrabbit.oak.api.Tree typeRoot,
                                         org.apache.jackrabbit.oak.api.Tree parent,
                                         String childName)

Finds the default primary type for a new child node with the given name.

Parameters:

typeRoot - root of the /jcr:system/jcr:nodeTypes tree

parent - parent node

childName - name of the new child node

Returns:

name of the default type, or null if not available

getEffectiveType

public static List<org.apache.jackrabbit.oak.api.Tree> getEffectiveType(org.apache.jackrabbit.oak.api.Tree tree,
                                                                        org.apache.jackrabbit.oak.api.Tree typeRoot)

Returns the effective node types of the given node.

findDefaultPrimaryType

public static String findDefaultPrimaryType(org.apache.jackrabbit.oak.api.Tree definitions,
                                            boolean sns)

isNodeType

public static boolean isNodeType(org.apache.jackrabbit.oak.api.Tree tree,
                                 String typeName,
                                 org.apache.jackrabbit.oak.api.Tree typeRoot)

isReadOnlyTree

public static boolean isReadOnlyTree(@Nonnull
                                     org.apache.jackrabbit.oak.api.Tree tree)

Returns true if the specified tree is a read-only tree..

Parameters:

tree - The tree object to be tested.

Returns:

true if the specified tree is an immutable read-only tree.

See Also:

ReadOnly