svn commit: r752048 - /jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java

[an...@apache.org]

Author: angela
Date: Tue Mar 10 10:39:13 2009
New Revision: 752048

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

Modified:
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java?rev=752048&r1=752047&r2=752048&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/virtual/AbstractVISProvider.java Tue Mar 10 10:39:13 2009
@@ -94,7 +94,7 @@
     /**
      * Creates the root node state.
      *
-     * @return
+     * @return The virtual root node state.
      * @throws RepositoryException
      */
     protected abstract VirtualNodeState createRootNodeState() throws RepositoryException;
@@ -174,6 +174,8 @@
      * Returns the root state
      *
      * @return the root state
+     * @throws ItemStateException If the root node state does not exist and its
+     * creation fails.
      */
     public synchronized NodeState getRootState() throws ItemStateException {
         try {
@@ -327,6 +329,7 @@
      * adds the node state to the cache
      *
      * @param state
+     * @return The same state.
      */
     protected NodeState cache(NodeState state) {
         if (state != null) {
@@ -349,6 +352,7 @@
      * invalidates the item
      *
      * @param id
+     * @param recursive
      */
     public void invalidateItem(ItemId id, boolean recursive) {
         VirtualNodeState state = id.equals(rootNodeId) ? root : (VirtualNodeState) nodes.get(id);
@@ -371,7 +375,8 @@
     /**
      * retrieves the property definition for the given contraints
      *
-     * @param propertyName
+     * @param parent The parent node state.
+     * @param propertyName The name of the property.
      * @param type
      * @param multiValued
      * @return
@@ -386,6 +391,7 @@
     /**
      * Retrieves the node definition for the given contraints.
      *
+     * @param parent The parent state.
      * @param nodeName
      * @param nodeTypeName
      * @return