You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2015/03/07 15:18:21 UTC
svn commit: r1664854 -
/sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java
Author: olli
Date: Sat Mar 7 14:18:21 2015
New Revision: 1664854
URL: http://svn.apache.org/r1664854
Log:
style, fix javadoc
Modified:
sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java
Modified: sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java?rev=1664854&r1=1664853&r2=1664854&view=diff
==============================================================================
--- sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java (original)
+++ sling/trunk/bundles/jcr/contentloader/src/main/java/org/apache/sling/jcr/contentloader/internal/ContentCreator.java Sat Mar 7 14:18:21 2015
@@ -24,8 +24,7 @@ import java.util.Map;
import javax.jcr.RepositoryException;
/**
- * The <code>ContentCreator</code>
- * is used by the {@link ContentReader} to create the actual content.
+ * The <code>ContentCreator</code> is used by the {@link ContentReader} to create the actual content.
*
* @since 2.0.4
*/
@@ -38,85 +37,72 @@ public interface ContentCreator {
* To add child nodes, this method should be called to create a new child node.
* If all properties and child nodes have been added {@link #finishNode()} must be called.
*
- * @param name The name of the node.
+ * @param name The name of the node.
* @param primaryNodeType The primary node type or null.
- * @param mixinNodeTypes The mixin node types or null.
+ * @param mixinNodeTypes The mixin node types or null.
* @throws RepositoryException If anything goes wrong.
*/
- void createNode(String name,
- String primaryNodeType,
- String[] mixinNodeTypes)
- throws RepositoryException;
+ void createNode(String name, String primaryNodeType, String[] mixinNodeTypes) throws RepositoryException;
/**
* Indicates that a node is finished.
* The parent node of the current node becomes the current node.
+ *
* @throws RepositoryException
*/
- void finishNode()
- throws RepositoryException;
+ void finishNode() throws RepositoryException;
/**
* Create a new property to the current node.
- * @param name The property name.
+ *
+ * @param name The property name.
* @param propertyType The type of the property.
- * @param value The string value.
+ * @param value The string value.
* @throws RepositoryException
*/
- void createProperty(String name,
- int propertyType,
- String value)
- throws RepositoryException;
+ void createProperty(String name, int propertyType, String value) throws RepositoryException;
/**
* Create a new multi value property to the current node.
- * @param name The property name.
+ *
+ * @param name The property name.
* @param propertyType The type of the property.
- * @param values The string values.
+ * @param values The string values.
* @throws RepositoryException
*/
- void createProperty(String name,
- int propertyType,
- String[] values)
- throws RepositoryException;
+ void createProperty(String name, int propertyType, String[] values) throws RepositoryException;
/**
* Add a new property to the current node.
- * @param name The property name.
+ *
+ * @param name The property name.
* @param value The value.
* @throws RepositoryException
*/
- void createProperty(String name,
- Object value)
- throws RepositoryException;
+ void createProperty(String name, Object value) throws RepositoryException;
/**
* Add a new multi value property to the current node.
- * @param name The property name.
- * @param propertyType The type of the property.
+ *
+ * @param name The property name.
* @param values The values.
* @throws RepositoryException
*/
- void createProperty(String name,
- Object[] values)
- throws RepositoryException;
+ void createProperty(String name, Object[] values) throws RepositoryException;
/**
* Create a file and a resource node.
* After the nodes have been created, the current node is the resource node.
* So this method call should be followed by two calls to {@link #finishNode()}
* to be on the same level as before the file creation.
- * @param name The name of the file node
- * @param data The data of the file
- * @param mimeType The mime type or null
+ *
+ * @param name The name of the file node
+ * @param data The data of the file
+ * @param mimeType The mime type or null
* @param lastModified The last modified or -1
* @throws RepositoryException
*/
- void createFileAndResourceNode(String name,
- InputStream data,
- String mimeType,
- long lastModified)
- throws RepositoryException;
+ void createFileAndResourceNode(String name, InputStream data, String mimeType, long lastModified) throws RepositoryException;
/**
* Switch the current node to the path (which must be relative
@@ -127,52 +113,51 @@ public interface ContentCreator {
* returned.
* When the changes to the node are finished, {@link #finishNode()}
* must be callsed.
- * @param subPath The relative path
+ *
+ * @param subPath The relative path
* @param newNodeType Node typ for newly created nodes.
* @throws RepositoryException
*/
- boolean switchCurrentNode(String subPath, String newNodeType)
- throws RepositoryException;
-
-
+ boolean switchCurrentNode(String subPath, String newNodeType) throws RepositoryException;
+
/**
* Create a User in the jackrabbit UserManager
- * @param name the name of the user
- * @param password the password of the user
+ *
+ * @param name the name of the user
+ * @param password the password of the user
* @param extraProperties extra properties to assign to the created user
* @throws RepositoryException
*/
- void createUser(String name, String password, Map<String, Object> extraProperties)
- throws RepositoryException;
-
+ void createUser(String name, String password, Map<String, Object> extraProperties) throws RepositoryException;
+
/**
* Create a Group in the jackrabbit UserManager
- * @param name the name of the group
- * @param members the members of the group (principal names)
+ *
+ * @param name the name of the group
+ * @param members the members of the group (principal names)
* @param extraProperties extra properties to assign to the created group
* @throws RepositoryException
*/
- void createGroup(String name, String[] members, Map<String, Object> extraProperties)
- throws RepositoryException;
-
+ void createGroup(String name, String[] members, Map<String, Object> extraProperties) throws RepositoryException;
+
/**
* Creates an Access Control Entry for the current node for the specified
- * principal and privileges.
+ * principal and privileges.
*
- * @param principal the user or group id for the ACE
+ * @param principal the user or group id for the ACE
* @param grantedPrivileges the set of privileges to grant the principal
- * @param deniedPrivileges the set of privileges to deny the principal (for users only)
- * @param order specifies the position of the ACE in the containing ACL. (may be null)
- * Value should be one of these:
- * <table>
- * <tr><td>first</td><td>Place the target ACE as the first amongst its siblings</td></tr>
- * <tr><td>last</td><td>Place the target ACE as the last amongst its siblings</td></tr>
- * <tr><td>before xyz</td><td>Place the target ACE immediately before the sibling whose name is xyz</td></tr>
- * <tr><td>after xyz</td><td>Place the target ACE immediately after the sibling whose name is xyz</td></tr>
- * <tr><td>numeric</td><td>Place the target ACE at the specified index</td></tr>
- * </table>
+ * @param deniedPrivileges the set of privileges to deny the principal (for users only)
+ * @param order specifies the position of the ACE in the containing ACL. (may be null)
+ * Value should be one of these:
+ * <table>
+ * <tr><td>first</td><td>Place the target ACE as the first amongst its siblings</td></tr>
+ * <tr><td>last</td><td>Place the target ACE as the last amongst its siblings</td></tr>
+ * <tr><td>before xyz</td><td>Place the target ACE immediately before the sibling whose name is xyz</td></tr>
+ * <tr><td>after xyz</td><td>Place the target ACE immediately after the sibling whose name is xyz</td></tr>
+ * <tr><td>numeric</td><td>Place the target ACE at the specified index</td></tr>
+ * </table>
* @throws RepositoryException
*/
- void createAce(String principal, String [] grantedPrivileges, String [] deniedPrivileges, String order )
- throws RepositoryException;
+ void createAce(String principal, String[] grantedPrivileges, String[] deniedPrivileges, String order) throws RepositoryException;
+
}