svn commit: r1367874 - /sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java

[cz...@apache.org]

Author: cziegeler
Date: Wed Aug  1 07:28:14 2012
New Revision: 1367874

URL: http://svn.apache.org/viewvc?rev=1367874&view=rev
Log:
SLING-2530 : Implement CRUD based on resources

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java?rev=1367874&r1=1367873&r2=1367874&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java Wed Aug  1 07:28:14 2012
@@ -28,6 +28,14 @@ import java.util.Map;
  * A modifying resource provider allows to create, update, and delete
  * resources. Update is handled through {@link ModifiableValueMap}.
  *
+ * All changes should be kept in a transient store until {@link #commit()}
+ * is called. {@link #revert()} discards all transient changes.
+ *
+ * If the modifying resource provider needs to clean up resources when it
+ * is discarded like removing objects from the transient state which are
+ * not committed etc., it should also implement the {@link DynamicResourceProvider}
+ * interface.
+ *
  * @see ResourceProviderFactory#getResourceProvider(java.util.Map)
  * @see ResourceProviderFactory#getAdministrativeResourceProvider(java.util.Map)
  *