Package org.apache.sling.servlets.post

Class Modification

java.lang.Object

org.apache.sling.servlets.post.Modification

public class Modification
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Modification(ModificationType type, java.lang.String source, java.lang.String destination)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDestination()
java.lang.String	getSource()
ModificationType	getType()
static Modification	onCheckin(java.lang.String path)
static Modification	onCheckout(java.lang.String path)
static Modification	onCopied(java.lang.String srcPath, java.lang.String dstPath)	Records a 'copied' change.
static Modification	onCreated(java.lang.String path)	Records a 'created' change
static Modification	onDeleted(java.lang.String path)	Records a 'deleted' change
static Modification	onModified(java.lang.String path)	Records a 'modified' change
static Modification	onMoved(java.lang.String srcPath, java.lang.String dstPath)	Records a 'moved' change.
static Modification	onOrder(java.lang.String orderedPath, java.lang.String beforeSibling)	Records a 'order' change.
static Modification	onRestore(java.lang.String path, java.lang.String version)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Modification

public Modification(ModificationType type,
                    java.lang.String source,
                    java.lang.String destination)

Method Detail

getType

public ModificationType getType()

getSource

public java.lang.String getSource()

getDestination

public java.lang.String getDestination()

onModified

public static Modification onModified(java.lang.String path)

Records a 'modified' change

Parameters:

path - path of the item that was modified

Returns:

the modification

onCreated

public static Modification onCreated(java.lang.String path)

Records a 'created' change

Parameters:

path - path of the item that was created

Returns:

the modification

onDeleted

public static Modification onDeleted(java.lang.String path)

Records a 'deleted' change

Parameters:

path - path of the item that was deleted

Returns:

the modification

onMoved

public static Modification onMoved(java.lang.String srcPath,
                                   java.lang.String dstPath)

Records a 'moved' change.

Note: the moved change only records the basic move command. the implied changes on the moved properties and sub nodes are not recorded.

Parameters:

srcPath - source path of the node that was moved

dstPath - destination path of the node that was moved.

Returns:

the modification

onCopied

public static Modification onCopied(java.lang.String srcPath,
                                    java.lang.String dstPath)

Records a 'copied' change.

Note: the copy change only records the basic copy command. the implied changes on the copied properties and sub nodes are not recorded.

Parameters:

srcPath - source path of the node that was copied

dstPath - destination path of the node that was copied.

Returns:

the modification

onOrder

public static Modification onOrder(java.lang.String orderedPath,
                                   java.lang.String beforeSibling)

Records a 'order' change.

Parameters:

orderedPath - Path of the node that was reordered

beforeSibling - Name of the sibling node before which the source node has been inserted.

Returns:

the modification

onCheckin

public static Modification onCheckin(java.lang.String path)

onCheckout

public static Modification onCheckout(java.lang.String path)

onRestore

public static Modification onRestore(java.lang.String path,
                                     java.lang.String version)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object