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

Enum TreeType

java.lang.Object

java.lang.Enum<TreeType>

org.apache.jackrabbit.oak.plugins.tree.TreeType

All Implemented Interfaces:

Serializable, Comparable<TreeType>

public enum TreeType
extends Enum<TreeType>

Allows to distinguish different types of trees based on their name, ancestry or primary type. Currently the following types are supported:

• DEFAULT: the default type for trees that don't match any of the following types.
• ACCESS_CONTROL: A tree that stores access control content and requires special access permissions.
• HIDDEN: a hidden tree whose name starts with ":". Please note that the whole subtree of a hidden node is considered hidden.
• INTERNAL: repository internal content that is not hidden (e.g. permission store)
• VERSION: if a given tree is located within any of the version related stores defined by JSR 283. Depending on the permission evaluation implementation those items require special treatment.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESS_CONTROL	Access control content
DEFAULT	Regular trees that don't match any of the other types
HIDDEN	Hidden trees starting at a tree whose name starts with ':'.
INTERNAL	Repository internal content that is not hidden (e.g.
VERSION	Trees within the version, activity or configuration storage

Method Summary

Modifier and Type	Method	Description
static TreeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TreeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final TreeType DEFAULT

Regular trees that don't match any of the other types

ACCESS_CONTROL

public static final TreeType ACCESS_CONTROL

Access control content

HIDDEN

public static final TreeType HIDDEN

Hidden trees starting at a tree whose name starts with ':'.

See Also:

• NodeStateUtils.isHidden(String)

INTERNAL

public static final TreeType INTERNAL

Repository internal content that is not hidden (e.g. permission store)

VERSION

public static final TreeType VERSION

Trees within the version, activity or configuration storage

Method Details

values

public static TreeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TreeType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null