directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: rev 56354 - incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception
Date Tue, 02 Nov 2004 05:22:26 GMT
Author: akarasulu
Date: Mon Nov  1 21:22:24 2004
New Revision: 56354

Modified:
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAttributeInUseException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationNotSupportedException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameAlreadyBoundException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameNotFoundException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNamingException.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNoPermissionException.java
Log:
some javadoc changes/additions

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAttributeInUseException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAttributeInUseException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAttributeInUseException.java
Mon Nov  1 21:22:24 2004
@@ -31,18 +31,27 @@
  */
 public class LdapAttributeInUseException extends AttributeInUseException implements LdapException
 {
+    /**
+     * @see AttributeInUseException#AttributeInUseException()
+     */
     public LdapAttributeInUseException()
     {
         super();
     }
 
 
+    /**
+     * @see AttributeInUseException#AttributeInUseException(String)
+     */
     public LdapAttributeInUseException( String explanation )
     {
         super( explanation );
     }
 
 
+    /**
+     * @see LdapException#getResultCode()
+     */
     public ResultCodeEnum getResultCode()
     {
         return ResultCodeEnum.ENTRYALREADYEXISTS;

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationException.java
Mon Nov  1 21:22:24 2004
@@ -23,8 +23,8 @@
 
 
 /**
- * The Eve version of an {@link AuthenticationException} which associates the
- * {@link ResultCodeEnum.INVALIDCREDENTIALS} value with it.  
+ * A subclass of {@link AuthenticationException} which associates the
+ * {@link ResultCodeEnum.INVALIDCREDENTIALS} value with the type.
  *
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
@@ -35,6 +35,7 @@
     /**
      * Gets ResultCodeEnum.INVALIDCREDENTIALS every time.
      *
+     * @see LdapException#getResultCode() 
      * @return ResultCodeEnum.INVALIDCREDENTIALS
      */
     public ResultCodeEnum getResultCode()

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationNotSupportedException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationNotSupportedException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapAuthenticationNotSupportedException.java
Mon Nov  1 21:22:24 2004
@@ -23,8 +23,8 @@
 
 
 /**
- * An Eve subclass of the {@link AuthenticationNotSupportedException} carrying
- * along an unequivocal ResultCodeEnum value.
+ * A subclass of the {@link AuthenticationNotSupportedException} carrying along
+ * an unequivocal ResultCodeEnum value.
  *
  * @see <a href="http://java.sun.com/products/jndi/tutorial/ldap/models/exceptions.html">Exceptions</a>
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -80,7 +80,7 @@
 
 
     /**
-     * @see org.apache.ldap.common.exception.LdapException#getResultCode()
+     * @see LdapException#getResultCode()
      */
     public ResultCodeEnum getResultCode()
     {

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapException.java
Mon Nov  1 21:22:24 2004
@@ -21,7 +21,7 @@
 
 
 /**
- * An Eve exception add LDAP specific information to NamingExceptions.
+ * An interface for exceptions which add LDAP specific information to Exceptions.
  *
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
@@ -31,7 +31,7 @@
     /**
      * Gets the LDAP result code that would be associated with this exception.
      *
-     * @return
+     * @return the LDAP result code corresponding to this exception type.
      */
     public ResultCodeEnum getResultCode();
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameAlreadyBoundException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameAlreadyBoundException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameAlreadyBoundException.java
Mon Nov  1 21:22:24 2004
@@ -19,13 +19,14 @@
 
 import javax.naming.NameAlreadyBoundException;
 
-import org.apache.ldap.common.exception.LdapException;
 import org.apache.ldap.common.message.ResultCodeEnum;
 
 
 /**
- * An Eve specific NameAlreadyBoundException.
+ * A NameAlreadyBoundException which contains LDAP specific information such
+ * as a result code.
  *
+ * @see NameAlreadyBoundException
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */
@@ -36,6 +37,7 @@
      * Always returns ResultCodeEnum.ENTRYALREADYEXISTS.
      *
      * @see LdapException#getResultCode()
+     * @return ResultCodeEnum.ENTRYALREADYEXISTS all the time
      */
     public ResultCodeEnum getResultCode()
     {

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameNotFoundException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameNotFoundException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNameNotFoundException.java
Mon Nov  1 21:22:24 2004
@@ -19,18 +19,25 @@
 
 import javax.naming.NameNotFoundException;
 
-import org.apache.ldap.common.exception.LdapException;
 import org.apache.ldap.common.message.ResultCodeEnum;
 
 
 /**
- * Document this class.
+ * A NameNotFoundException holding LDAP specific information such as the
+ * LDAP ResultCode.
  *
+ * @see NameNotFoundException
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */
 public class LdapNameNotFoundException extends NameNotFoundException implements LdapException
 {
+    /**
+     * Gets the ResultCode associated with this exception which will always be
+     * ResultCodeEnum.NOSUCHOBJECT.
+     *
+     * @return ResultCodeEnum.NOSUCHOBJECT
+     */
     public ResultCodeEnum getResultCode()
     {
         return ResultCodeEnum.NOSUCHOBJECT;

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNamingException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNamingException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNamingException.java
Mon Nov  1 21:22:24 2004
@@ -20,7 +20,6 @@
 import javax.naming.NamingException;
 
 import org.apache.ldap.common.message.ResultCodeEnum;
-import org.apache.ldap.common.exception.LdapException;
 
 
 /**

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNoPermissionException.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNoPermissionException.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/exception/LdapNoPermissionException.java
Mon Nov  1 21:22:24 2004
@@ -20,7 +20,6 @@
 import javax.naming.NoPermissionException;
 
 import org.apache.ldap.common.message.ResultCodeEnum;
-import org.apache.ldap.common.exception.LdapException;
 
 
 /**

Mime
View raw message