jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r555314 - in /jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi: Batch.java ItemInfo.java LockInfo.java NodeId.java NodeInfo.java PropertyId.java
Date Wed, 11 Jul 2007 15:39:51 GMT
Author: angela
Date: Wed Jul 11 08:39:50 2007
New Revision: 555314

URL: http://svn.apache.org/viewvc?view=rev&rev=555314
Log:
javadoc

Modified:
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/Batch.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/Batch.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/Batch.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/Batch.java (original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/Batch.java Wed
Jul 11 08:39:50 2007
@@ -29,14 +29,22 @@
 import javax.jcr.version.VersionException;
 
 /**
- * <code>Batch</code>...
+ * <code>Batch</code> defines a set of modifications that must be executed and
+ * persisted at once. If any of the modifications added to the batch fails, none
+ * of the other changes must be persisted, thus leaving the persistent layer
+ * unaffected by the given batch. The <code>Batch</code> object is obtained by
calling
+ * {@link RepositoryService#createBatch(ItemId, SessionInfo)}. The modifications
+ * collected in a Batch are persisted upon a sucessful call to
+ * {@link RepositoryService#submit(Batch)}.
  */
 public interface Batch {
 
     /**
-     * @param parentId
-     * @param nodeName Name of the node to be created
-     * @param nodetypeName
+     * Add a new node to the persistent layer.
+     *
+     * @param parentId NodeId identifying the parent node.
+     * @param nodeName Name of the node to be created.
+     * @param nodetypeName Primary node type name of the node to be created.
      * @param uuid Value for the jcr:uuid property of the node to be created or
      * <code>null</code>. If due to an import the uuid of the resulting node
is
      * already defined, it must be passed as separate uuid parameter, indicating
@@ -58,10 +66,11 @@
     public void addNode(NodeId parentId, QName nodeName, QName nodetypeName, String uuid)
throws RepositoryException;
 
     /**
+     * Add a new property to the persistent layer.
      *
-     * @param parentId
-     * @param propertyName Name of the property to be created
-     * @param value
+     * @param parentId NodeId identifying the parent node.
+     * @param propertyName Name of the property to be created.
+     * @param value The qualified value of the property to be created.
      * @throws ValueFormatException
      * @throws VersionException
      * @throws LockException
@@ -86,9 +95,11 @@
     public void addProperty(NodeId parentId, QName propertyName, QValue value) throws ValueFormatException,
VersionException, LockException, ConstraintViolationException, PathNotFoundException, ItemExistsException,
AccessDeniedException, UnsupportedRepositoryOperationException, RepositoryException;
 
     /**
-     * @param parentId
-     * @param propertyName Name of the property to be created
-     * @param values
+     * Add a new multi-valued property to the persistent layer.
+     *
+     * @param parentId NodeId identifying the parent node.
+     * @param propertyName Name of the property to be created.
+     * @param values The qualified values of the property to be created.
      * @throws javax.jcr.ValueFormatException
      * @throws javax.jcr.version.VersionException
      * @throws javax.jcr.lock.LockException
@@ -107,9 +118,10 @@
     public void addProperty(NodeId parentId, QName propertyName, QValue[] values) throws
ValueFormatException, VersionException, LockException, ConstraintViolationException, PathNotFoundException,
ItemExistsException, AccessDeniedException, UnsupportedRepositoryOperationException, RepositoryException;
 
     /**
+     * Modify the value of an existing property.
      *
-     * @param propertyId
-     * @param value
+     * @param propertyId PropertyId identifying the property to be modified.
+     * @param value The new value.
      * @throws ValueFormatException
      * @throws VersionException
      * @throws LockException
@@ -128,8 +140,10 @@
     public void setValue(PropertyId propertyId, QValue value) throws RepositoryException;
 
     /**
-     * @param propertyId
-     * @param values
+     * Modify the value of an existing, multi-valued property.
+     *
+     * @param propertyId PropertyId identifying the property to be modified.
+     * @param values The new values.
      * @throws javax.jcr.ValueFormatException
      * @throws javax.jcr.version.VersionException
      * @throws javax.jcr.lock.LockException
@@ -143,7 +157,9 @@
     public void setValue(PropertyId propertyId, QValue[] values) throws RepositoryException;
 
     /**
-     * @param itemId
+     * Remove an existing item.
+     *
+     * @param itemId ItemId identifying the item to be removed.
      * @throws javax.jcr.version.VersionException
      * @throws javax.jcr.lock.LockException
      * @throws javax.jcr.nodetype.ConstraintViolationException
@@ -155,9 +171,13 @@
     public void remove(ItemId itemId) throws RepositoryException;
 
     /**
-     * @param parentId
-     * @param srcNodeId
-     * @param beforeNodeId
+     * Modify the order of the child nodes identified by the given
+     * <code>NodeId</code>s.
+     *
+     * @param parentId NodeId identifying the parent node.
+     * @param srcNodeId NodeId identifying the node to be reordered.
+     * @param beforeNodeId NodeId identifying the child node, before which the
+     * source node must be placed.
      * @throws javax.jcr.UnsupportedRepositoryOperationException
      * @throws javax.jcr.version.VersionException
      * @throws javax.jcr.nodetype.ConstraintViolationException
@@ -170,8 +190,12 @@
     public void reorderNodes(NodeId parentId, NodeId srcNodeId, NodeId beforeNodeId) throws
RepositoryException;
 
     /**
-     * @param nodeId
-     * @param mixinNodeTypeIds
+     * Modify the set of mixin node types present on the node identified by the
+     * given id.
+     *
+     * @param nodeId NodeId identifying the node to be modified.
+     * @param mixinNodeTypeIds The new set of mixin types. Compared to the
+     * previous values this may result in both adding and/or removing mixin types.
      * @throws javax.jcr.nodetype.NoSuchNodeTypeException
      * @throws javax.jcr.version.VersionException
      * @throws javax.jcr.nodetype.ConstraintViolationException
@@ -180,13 +204,18 @@
      * @throws javax.jcr.UnsupportedRepositoryOperationException
      * @throws javax.jcr.RepositoryException
      * @see javax.jcr.Node#addMixin(String)
+     * @see javax.jcr.Node#removeMixin(String)
      */
     public void setMixins(NodeId nodeId, QName[] mixinNodeTypeIds) throws RepositoryException;
 
     /**
-     * @param srcNodeId
-     * @param destParentNodeId
-     * @param destName
+     * Move the node identified by the given <code>srcNodeId</code> to the
+     * new parent identified by <code>destParentNodeId</code> and change its
+     * name to <code>destName</code>.
+     *
+     * @param srcNodeId NodeId identifying the node to be moved.
+     * @param destParentNodeId NodeId identifying the new parent.
+     * @param destName The new name of the moved node.
      * @throws javax.jcr.ItemExistsException
      * @throws javax.jcr.PathNotFoundException
      * @throws javax.jcr.version.VersionException

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java
Wed Jul 11 08:39:50 2007
@@ -25,22 +25,32 @@
 public interface ItemInfo {
 
     /**
+     * Returns the id of the parent <code>NodeInfo</code>.
+     *
      * @return the id of the parent item info.
      */
     public NodeId getParentId();
 
     /**
-     * @return Return the qualified representation of the item name.
+     * Returns the qualified representation of the item name. For the root node
+     * expected return value is {@link QName#ROOT}.
+     *
+     * @return the qualified representation of the item name.
      */
     public QName getQName();
 
     /**
-     * @return Return true if this ItemInfo denotes a node, false otherwise.
+     * Returns true if this <code>ItemInfo</code> denotes a node, false otherwise.
+     *
+     * @return true if this <code>ItemInfo</code> denotes a node, false otherwise.
      */
     public boolean denotesNode();
 
     /**
-     * @return Return the <code>Path</code> of the Item represented by this
+     * Returns the <code>Path</code> of the item represented by this
+     * <code>ItemInfo</code>.
+     *
+     * @return the <code>Path</code> of the item represented by this
      * item info.
      */
     public Path getPath();

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
Wed Jul 11 08:39:50 2007
@@ -17,7 +17,11 @@
 package org.apache.jackrabbit.spi;
 
 /**
- * <code>LockInfo</code>...
+ * <code>LockInfo</code> is used to transport lock information across the SPI
+ * boundary.
+ *
+ * @see RepositoryService#getLockInfo(SessionInfo, NodeId)
+ * @see RepositoryService#lock(SessionInfo, NodeId, boolean, boolean) 
  */
 public interface LockInfo {
 

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java (original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java Wed
Jul 11 08:39:50 2007
@@ -17,7 +17,8 @@
 package org.apache.jackrabbit.spi;
 
 /**
- * <code>NodeId</code>...
+ * <code>NodeId</code> identifies a node on the SPI layer. The interface does
+ * not add additional methods.
  */
 public interface NodeId extends ItemId {
 

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java
Wed Jul 11 08:39:50 2007
@@ -26,6 +26,9 @@
 public interface NodeInfo extends ItemInfo {
 
     /**
+     * Returns the <code>NodeId</code> for the node that is based on this info
+     * object.
+     *
      * @return identifier for the item that is based on this info object. the id
      * can either be an absolute path or a uniqueID (+ relative path).
      * @see RepositoryService#getNodeInfo(SessionInfo, NodeId)

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java?view=diff&rev=555314&r1=555313&r2=555314
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java
Wed Jul 11 08:39:50 2007
@@ -19,16 +19,20 @@
 import org.apache.jackrabbit.name.QName;
 
 /**
- * <code>PropertyId</code>...
+ * <code>PropertyId</code> identifies a property on the SPI layer.
  */
 public interface PropertyId extends ItemId {
 
     /**
+     * Returns the <code>NodeId</code> of the parent.
+     *
      * @return The {@link NodeId parentId} of this <code>PropertyId</code>.
      */
     public NodeId getParentId();
 
     /**
+     * Returns the {@link QName name} of the property identified by this id.
+     * 
      * @return The name of the property that is identified by this <code>PropertyId</code>.
      */
     public QName getQName();



Mime
View raw message