Package org.apache.jackrabbit.oak.plugins.document

Enum NodeDocument.SplitDocType

java.lang.Object

java.lang.Enum<NodeDocument.SplitDocType>

org.apache.jackrabbit.oak.plugins.document.NodeDocument.SplitDocType

All Implemented Interfaces:

Serializable, Comparable<NodeDocument.SplitDocType>

Enclosing class:

NodeDocument

public static enum NodeDocument.SplitDocType
extends Enum<NodeDocument.SplitDocType>

A document which is created from splitting a main document can be classified into multiple types depending on the content i.e. weather it contains REVISIONS, COMMIT_ROOT, property history etc

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMIT_ROOT_ONLY	A split document which does not contain REVISIONS history.
DEFAULT	A split document which contains all types of data
DEFAULT_LEAF	A split document which contains all types of data.
DEFAULT_NO_BRANCH	A split document which contains all types of data, but no branch commits.
DEFAULT_NO_CHILD	Deprecated.
INTERMEDIATE	Its an intermediate split document which only contains version ranges and does not contain any other attributes
NONE	Not a split document
PROP_COMMIT_ONLY	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	typeCode()
static NodeDocument.SplitDocType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NodeDocument.SplitDocType[]	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 Detail

NONE

public static final NodeDocument.SplitDocType NONE

Not a split document

DEFAULT

public static final NodeDocument.SplitDocType DEFAULT

A split document which contains all types of data

DEFAULT_NO_CHILD

@Deprecated
public static final NodeDocument.SplitDocType DEFAULT_NO_CHILD

Deprecated.

A split document which contains all types of data. In addition when the split document was created the main document did not had any child. This type is deprecated because these kind of documents cannot be garbage collected independently. The main document may still reference _commitRoot entries in the previous document. See OAK-1794

PROP_COMMIT_ONLY

@Deprecated
public static final NodeDocument.SplitDocType PROP_COMMIT_ONLY

Deprecated.

A split document which does not contain REVISIONS history. This type is deprecated because these kind of documents cannot be garbage collected independently. The main document may still reference _commitRoot entries in the previous document. See OAK-1794

INTERMEDIATE

public static final NodeDocument.SplitDocType INTERMEDIATE

Its an intermediate split document which only contains version ranges and does not contain any other attributes

DEFAULT_LEAF

public static final NodeDocument.SplitDocType DEFAULT_LEAF

A split document which contains all types of data. In addition when the split document was created the main document did not had any child.

COMMIT_ROOT_ONLY

public static final NodeDocument.SplitDocType COMMIT_ROOT_ONLY

A split document which does not contain REVISIONS history.

DEFAULT_NO_BRANCH

public static final NodeDocument.SplitDocType DEFAULT_NO_BRANCH

A split document which contains all types of data, but no branch commits.

Method Detail

values

public static NodeDocument.SplitDocType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NodeDocument.SplitDocType c : NodeDocument.SplitDocType.values())
    System.out.println(c);

Returns:

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

valueOf

public static NodeDocument.SplitDocType 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

typeCode

public int typeCode()