svn commit: r947282 - /directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java

[se...@apache.org]

Author: seelmann
Date: Sat May 22 11:39:19 2010
New Revision: 947282

URL: http://svn.apache.org/viewvc?rev=947282&view=rev
Log:
Javadoc

Modified:
    directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java

Modified: directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java?rev=947282&r1=947281&r2=947282&view=diff
==============================================================================
--- directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java (original)
+++ directory/apacheds/trunk/xdbm-search/src/main/java/org/apache/directory/server/xdbm/Store.java Sat May 22 11:39:19 2010
@@ -117,7 +117,7 @@ public interface Store<E, ID extends Com
     public static final Set<String> SYS_INDEX_OIDS = Collections.unmodifiableSet( new HashSet<String>( Arrays
         .asList( SYS_INDEX_OID_ARRAY ) ) );
 
-    
+
     /**
      * Sets the partition directory (working directory) for the store.
      * 
@@ -396,9 +396,10 @@ public interface Store<E, ID extends Com
 
 
     /**
-     * Gets the normalized DN of the entry identified by the given id.
-     * @param id the entry's id
-     * @return the normalized entry DN
+     * Gets the entry's id. Returns <code>null</code> if the DN doesn't exist in this store.
+     * Note that the DN must be normalized!
+     * @param dn the normalized entry DN
+     * @return the entry's id, or <code>null</code> if the DN doesn't exists
      */
     DN getEntryDn( ID id ) throws Exception;
 
@@ -460,7 +461,7 @@ public interface Store<E, ID extends Com
      */
     IndexCursor<ID, E, ID> list( ID id ) throws Exception;
 
-    
+
     /**
      * Gets the count of immediate children of the given entry ID.
      *