Class DefaultEditor
- java.lang.Object
-
- org.apache.jackrabbit.oak.spi.commit.DefaultEditor
-
- All Implemented Interfaces:
Editor
- Direct Known Subclasses:
AtomicCounterEditor
,SubtreeEditor
,TypeEditor
,VersionableEditor
,VersionablePropertiesEditor
public class DefaultEditor extends Object implements Editor
Editor that does nothing by default and doesn't recurse into subtrees. Useful as a sentinel or as a base class for more complex editors.- Since:
- Oak 0.7
-
-
Constructor Summary
Constructors Constructor Description DefaultEditor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Editor
childNodeAdded(String name, NodeState after)
Processes an added child node.Editor
childNodeChanged(String name, NodeState before, NodeState after)
Processes a changed child node.Editor
childNodeDeleted(String name, NodeState before)
Processes a deleted child node.void
enter(NodeState before, NodeState after)
Called before the given before and after states are compared.void
leave(NodeState before, NodeState after)
Called after the given before and after states are compared.void
propertyAdded(PropertyState after)
Processes an added property.void
propertyChanged(PropertyState before, PropertyState after)
Processes a changed property.void
propertyDeleted(PropertyState before)
Processes a removed property.
-
-
-
Field Detail
-
INSTANCE
public static final Editor INSTANCE
-
-
Method Detail
-
enter
public void enter(NodeState before, NodeState after) throws CommitFailedException
Description copied from interface:Editor
Called before the given before and after states are compared. The implementation can use this method to initialize any internal state needed for processing the results of the comparison. For example an implementation could look up the effective node type of the after state to know what constraints to apply to on the content changes.- Specified by:
enter
in interfaceEditor
- Parameters:
before
- before state, non-existent if this node was addedafter
- after state, non-existent if this node was removed- Throws:
CommitFailedException
- if this commit should be rejected
-
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 interfaceEditor
- Parameters:
before
- before state, non-existent if this node was addedafter
- after state, non-existent if this node was removed- Throws:
CommitFailedException
- if this commit should be rejected
-
propertyAdded
public void propertyAdded(PropertyState after) throws CommitFailedException
Description copied from interface:Editor
Processes an added property.- Specified by:
propertyAdded
in interfaceEditor
- Parameters:
after
- the added property- Throws:
CommitFailedException
- if processing failed
-
propertyChanged
public void propertyChanged(PropertyState before, PropertyState after) throws CommitFailedException
Description copied from interface:Editor
Processes a changed property.- Specified by:
propertyChanged
in interfaceEditor
- Parameters:
before
- the original propertyafter
- the changed property- Throws:
CommitFailedException
- if processing failed
-
propertyDeleted
public void propertyDeleted(PropertyState before) throws CommitFailedException
Description copied from interface:Editor
Processes a removed property.- Specified by:
propertyDeleted
in interfaceEditor
- Parameters:
before
- the removed property- Throws:
CommitFailedException
- if processing failed
-
childNodeAdded
public Editor childNodeAdded(String name, NodeState after) throws CommitFailedException
Description copied from interface:Editor
Processes an added child node.- Specified by:
childNodeAdded
in interfaceEditor
- Parameters:
name
- name of the added nodeafter
- 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(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 interfaceEditor
- Parameters:
name
- name of the changed nodebefore
- child node before the changeafter
- 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(String name, NodeState before) throws CommitFailedException
Description copied from interface:Editor
Processes a deleted child node.- Specified by:
childNodeDeleted
in interfaceEditor
- Parameters:
name
- name of the deleted nodebefore
- 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
-
-