svn commit: r581235 - /jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java

[an...@apache.org]

Author: angela
Date: Tue Oct  2 06:40:30 2007
New Revision: 581235

URL: http://svn.apache.org/viewvc?rev=581235&view=rev
Log:
javadoc: mention the intended usage of the idfactory and the fact that the client might not be aware of the uniqueID of an item.

Modified:
    jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java

Modified: jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java?rev=581235&r1=581234&r2=581235&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java (original)
+++ jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java Tue Oct  2 06:40:30 2007
@@ -21,6 +21,13 @@
 
 /**
  * <code>IdFactory</code> defines methods to construct new <code>ItemId</code>s.
+ * This factory is intended to build <code>ItemId</code>s from the parameters
+ * passed to the various create methods and should not make an attempt to
+ * apply additional logic such as e.g. roundtrips to the server or resolution of
+ * <code>Path</code>s. Similarly the SPI implementation namely the
+ * {@link RepositoryService} must be able to deal with the various formats of
+ * an <code>ItemId</code>, since a caller may not (yet) be aware of the uniqueID
+ * part of an ItemId. 
  */
 public interface IdFactory {