jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r483030 - in /jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version: VersionHistoryImpl.java VersionManager.java
Date Wed, 06 Dec 2006 11:06:23 GMT
Author: angela
Date: Wed Dec  6 03:06:23 2006
New Revision: 483030

URL: http://svn.apache.org/viewvc?view=rev&rev=483030
Log:
work in progress

- javadoc

Modified:
    jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionHistoryImpl.java
    jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java

Modified: jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionHistoryImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionHistoryImpl.java?view=diff&rev=483030&r1=483029&r2=483030
==============================================================================
--- jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionHistoryImpl.java
(original)
+++ jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionHistoryImpl.java
Wed Dec  6 03:06:23 2006
@@ -301,7 +301,9 @@
      * @throws RepositoryException
      * @see VersionHistory#removeVersion(String)
      */
-    public void removeVersion(String versionName) throws RepositoryException {
+    public void removeVersion(String versionName) throws ReferentialIntegrityException,
+        AccessDeniedException, UnsupportedRepositoryOperationException,
+        VersionException, RepositoryException {
         checkStatus();
         NodeState vState = getVersionState(versionName);
         session.getVersionManager().removeVersion(vhState, vState);

Modified: jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java?view=diff&rev=483030&r1=483029&r2=483030
==============================================================================
--- jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java
(original)
+++ jackrabbit/trunk/contrib/spi/jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java
Wed Dec  6 03:06:23 2006
@@ -22,51 +22,151 @@
 import org.apache.jackrabbit.spi.IdIterator;
 
 import javax.jcr.RepositoryException;
+import javax.jcr.UnsupportedRepositoryOperationException;
+import javax.jcr.InvalidItemStateException;
+import javax.jcr.ReferentialIntegrityException;
+import javax.jcr.AccessDeniedException;
+import javax.jcr.ItemExistsException;
+import javax.jcr.NoSuchWorkspaceException;
+import javax.jcr.MergeException;
+import javax.jcr.lock.LockException;
 import javax.jcr.version.VersionException;
+import javax.jcr.version.Version;
 
 /**
  * <code>VersionManager</code>...
  */
 public interface VersionManager {
 
-    // TODO fix method definitions (throw clauses)
-
-    public void checkin(NodeState nodeState) throws RepositoryException;
+    /**
+     * @param nodeState
+     * @throws VersionException
+     * @throws UnsupportedRepositoryOperationException
+     * @throws InvalidItemStateException
+     * @throws LockException
+     * @throws RepositoryException
+     * @see javax.jcr.Node#checkin()
+     */
+    public void checkin(NodeState nodeState) throws VersionException, UnsupportedRepositoryOperationException,
InvalidItemStateException, LockException, RepositoryException;
 
-    public void checkout(NodeState nodeState) throws RepositoryException;
+    /**
+     * @param nodeState
+     * @throws UnsupportedRepositoryOperationException
+     * @throws LockException
+     * @throws RepositoryException
+     * @see javax.jcr.Node#checkout()
+     */
+    public void checkout(NodeState nodeState) throws UnsupportedRepositoryOperationException,
LockException, RepositoryException;
 
+    /**
+     * @param nodeState
+     * @return
+     * @throws RepositoryException
+     * @see javax.jcr.Node#isCheckedOut()
+     */
     public boolean isCheckedOut(NodeState nodeState) throws RepositoryException;
 
+    /**
+     * @param nodeState
+     * @throws VersionException If the <code>Node</code> represented by the given
+     * <code>NodeState</code> is checkedin.
+     * @throws RepositoryException If another error occurs.
+     * @see javax.jcr.Node#isCheckedOut()
+     */
     public void checkIsCheckedOut(NodeState nodeState) throws VersionException, RepositoryException;
 
-    public void removeVersion(NodeState versionHistoryState, NodeState versionState) throws
RepositoryException;
+    /**
+     * @param versionHistoryState
+     * @param versionState
+     * @throws ReferentialIntegrityException
+     * @throws AccessDeniedException
+     * @throws UnsupportedRepositoryOperationException
+     * @throws VersionException
+     * @throws RepositoryException
+     * @see javax.jcr.version.VersionHistory#removeVersion(String)
+     */
+    public void removeVersion(NodeState versionHistoryState, NodeState versionState) throws
ReferentialIntegrityException, AccessDeniedException, UnsupportedRepositoryOperationException,
VersionException, RepositoryException;
 
-    public void addVersionLabel(NodeState versionHistoryState, NodeState versionState, QName
qLabel, boolean moveLabel) throws RepositoryException;
+    /**
+     * @param versionHistoryState
+     * @param versionState
+     * @param qLabel
+     * @param moveLabel
+     * @throws VersionException
+     * @throws RepositoryException
+     * @see javax.jcr.version.VersionHistory#addVersionLabel(String, String, boolean)
+     */
+    public void addVersionLabel(NodeState versionHistoryState, NodeState versionState, QName
qLabel, boolean moveLabel) throws VersionException, RepositoryException;
 
-    public void removeVersionLabel(NodeState versionHistoryState, NodeState versionState,
QName qLabel) throws RepositoryException;
+    /**
+     * @param versionHistoryState
+     * @param versionState
+     * @param qLabel
+     * @throws VersionException
+     * @throws RepositoryException
+     * @see javax.jcr.version.VersionHistory#removeVersionLabel(String)
+     */
+    public void removeVersionLabel(NodeState versionHistoryState, NodeState versionState,
QName qLabel) throws VersionException, RepositoryException;
 
-    public void restore(NodeState nodeState, Path relativePath, NodeState versionState, boolean
removeExisting) throws RepositoryException;
+    /**
+     * @param nodeState
+     * @param relativePath
+     * @param versionState
+     * @param removeExisting
+     * @throws VersionException
+     * @throws ItemExistsException
+     * @throws UnsupportedRepositoryOperationException
+     * @throws LockException
+     * @throws InvalidItemStateException
+     * @throws RepositoryException
+     * @see javax.jcr.Node#restore(String, boolean)
+     * @see javax.jcr.Node#restore(Version, boolean)
+     * @see javax.jcr.Node#restore(Version, String, boolean)
+     * @see javax.jcr.Node#restoreByLabel(String, boolean)
+     */
+    public void restore(NodeState nodeState, Path relativePath, NodeState versionState, boolean
removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException,
LockException, InvalidItemStateException, RepositoryException;
 
-    public void restore(NodeState[] versionStates, boolean removeExisting) throws RepositoryException;
+    /**
+     * @param versionStates
+     * @param removeExisting
+     * @throws ItemExistsException
+     * @throws UnsupportedRepositoryOperationException
+     * @throws VersionException
+     * @throws LockException
+     * @throws InvalidItemStateException
+     * @throws RepositoryException
+     * @see javax.jcr.Workspace#restore(Version[], boolean)
+     */
+    public void restore(NodeState[] versionStates, boolean removeExisting) throws ItemExistsException,
UnsupportedRepositoryOperationException, VersionException, LockException, InvalidItemStateException,
RepositoryException;
 
     /**
-     *
      * @param nodeState
      * @param workspaceName
      * @param bestEffort
      * @return A Collection of <code>ItemId</code> containing the ids of those
      * <code>Node</code>s that failed to be merged and need manual resolution
      * by the user of the API.
+     * @throws NoSuchWorkspaceException
+     * @throws AccessDeniedException
+     * @throws MergeException
+     * @throws LockException
+     * @throws InvalidItemStateException
+     * @throws RepositoryException
      * @see #resolveMergeConflict(NodeState,NodeState,boolean)
+     * @see javax.jcr.Node#merge(String, boolean) 
      */
-    public IdIterator merge(NodeState nodeState, String workspaceName, boolean bestEffort)
throws RepositoryException;
+    public IdIterator merge(NodeState nodeState, String workspaceName, boolean bestEffort)
throws NoSuchWorkspaceException, AccessDeniedException, MergeException, LockException, InvalidItemStateException,
RepositoryException;
 
     /**
-     * 
      * @param nodeState
      * @param versionState
      * @param done
+     * @throws VersionException
+     * @throws InvalidItemStateException
+     * @throws UnsupportedRepositoryOperationException
      * @throws RepositoryException
+     * @see javax.jcr.Node#cancelMerge(Version)
+     * @see javax.jcr.Node#doneMerge(Version)
      */
-    public void resolveMergeConflict(NodeState nodeState, NodeState versionState, boolean
done) throws RepositoryException;
+    public void resolveMergeConflict(NodeState nodeState, NodeState versionState, boolean
done) throws VersionException, InvalidItemStateException, UnsupportedRepositoryOperationException,
RepositoryException;
 }



Mime
View raw message