Package org.apache.jackrabbit.oak.plugins.migration.version

Class VersionableEditor

java.lang.Object

org.apache.jackrabbit.oak.spi.commit.DefaultEditor

org.apache.jackrabbit.oak.plugins.migration.version.VersionableEditor

All Implemented Interfaces:

Editor

public class VersionableEditor
extends DefaultEditor

The VersionableEditor provides two possible ways to handle versionable nodes:

• it can copy the version histories of versionable nodes, or
• it can skip copying version histories and remove the mix:versionable mixin together with any related properties (see VersionHistoryUtil.removeVersionProperties(NodeBuilder, TypePredicate)).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VersionableEditor.Provider

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.spi.commit.DefaultEditor

INSTANCE

Method Summary

Modifier and Type	Method	Description
Editor	childNodeAdded(java.lang.String name, NodeState after)	Processes an added child node.
Editor	childNodeChanged(java.lang.String name, NodeState before, NodeState after)	Processes a changed child node.
Editor	childNodeDeleted(java.lang.String name, NodeState before)	Processes a deleted child node.
void	leave(NodeState before, NodeState after)	Called after the given before and after states are compared.

Methods inherited from class org.apache.jackrabbit.oak.spi.commit.DefaultEditor

enter, propertyAdded, propertyChanged, propertyDeleted

Methods inherited from class java.lang.Object

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

Method Detail

childNodeAdded

public Editor childNodeAdded(java.lang.String name,
                             NodeState after)
                      throws CommitFailedException

Description copied from interface: Editor

Processes an added child node.

Specified by:

childNodeAdded in interface Editor

Overrides:

childNodeAdded in class DefaultEditor

Parameters:

name - name of the added node

after - the added child node

Returns:

an editor for processing the subtree below the added node, or null if the subtree does not need processing

Throws:

CommitFailedException - if processing failed

childNodeChanged

public Editor childNodeChanged(java.lang.String name,
                               NodeState before,
                               NodeState after)
                        throws CommitFailedException

Description copied from interface: Editor

Processes a changed child node. This method gets called for all child nodes that may contain changes between the before and after states.

Specified by:

childNodeChanged in interface Editor

Overrides:

childNodeChanged in class DefaultEditor

Parameters:

name - name of the changed node

before - child node before the change

after - child node after the change

Returns:

an editor for processing the subtree below the added node, or null if the subtree does not need processing

Throws:

CommitFailedException - if processing failed

childNodeDeleted

public Editor childNodeDeleted(java.lang.String name,
                               NodeState before)
                        throws CommitFailedException

Description copied from interface: Editor

Processes a deleted child node.

Specified by:

childNodeDeleted in interface Editor

Overrides:

childNodeDeleted in class DefaultEditor

Parameters:

name - name of the deleted node

before - the deleted child node

Returns:

an editor for processing the subtree below the removed node, or null if the subtree does not need processing

Throws:

CommitFailedException - if processing failed

leave

public void leave(NodeState before,
                  NodeState after)
           throws CommitFailedException

Description copied from interface: Editor

Called after the given before and after states are compared. The implementation can use this method to post-process information collected during the content diff. For example an implementation that during the diff just recorded the fact that this node was modified in some way could then use this method to trigger an index update based on that modification flag.

Specified by:

leave in interface Editor

Overrides:

leave in class DefaultEditor

Parameters:

before - before state, non-existent if this node was added

after - after state, non-existent if this node was removed

Throws:

CommitFailedException - if this commit should be rejected