Mailing-List: contact commits-help@directory.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@directory.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1772098 -
 /directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java
Date: Wed, 30 Nov 2016 17:54:52 -0000
To: commits@directory.apache.org
From: elecharny@apache.org
Message-Id: <20161130175453.52FF13A00EA@svn01-us-west.apache.org>
archived-at: Wed, 30 Nov 2016 17:55:02 -0000

Author: elecharny
Date: Wed Nov 30 17:54:52 2016
New Revision: 1772098

URL: http://svn.apache.org/viewvc?rev=1772098&view=rev
Log:
Added some missing javadoc

Modified:
    directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java

Modified: directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java?rev=1772098&r1=1772097&r2=1772098&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java (original)
+++ directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java Wed Nov 30 17:54:52 2016
@@ -93,7 +93,14 @@ public final class JndiUtils
     }
 
 
-    // @TODO not really needed and can be moved out
+   /**
+    * Convert a LDAP API control to a JNDI control
+    * @param codec The LDAP API service to use
+    * @param control The control to convert
+    * @return A JNDI control
+    * @throws EncoderException If the conversion failed
+    */
+    @Deprecated
     public static javax.naming.ldap.Control toJndiControl( LdapApiService codec, Control control )
         throws EncoderException
     {
@@ -101,7 +108,14 @@ public final class JndiUtils
     }
 
 
-    // @TODO not really needed and can be moved out
+    /**
+     * Convert some LDAP API controls to JNDI controls
+     * @param codec The LDAP API service to use
+     * @param controls The controls to convert
+     * @return Aarray of JNDI control
+     * @throws EncoderException If the conversion failed
+     */
+    @Deprecated
     public static javax.naming.ldap.Control[] toJndiControls( LdapApiService codec, Control... controls )
         throws EncoderException
     {
@@ -124,7 +138,14 @@ public final class JndiUtils
     }
 
 
-    // @TODO not really needed and can be moved out
+    /**
+     * Convert a JNDI control to a LDAP API control
+     * @param codec The LDAP API service to use
+     * @param jndiControl The control to convert
+     * @return A LDAP API control
+     * @throws DecoderException If the conversion failed
+     */
+    @Deprecated
     public static Control fromJndiControl( LdapApiService codec, javax.naming.ldap.Control jndiControl )
         throws DecoderException
     {
@@ -132,7 +153,14 @@ public final class JndiUtils
     }
 
 
-    // @TODO not really needed and can be moved out
+    /**
+     * Convert some JNDI controls to LDAP API controls
+     * @param codec The LDAP API service to use
+     * @param jndiControls The controls to convert
+     * @return An arrau of LDAP API control
+     * @throws DecoderException If the conversion failed
+     */
+    @Deprecated
     public static Control[] fromJndiControls( LdapApiService codec, javax.naming.ldap.Control... jndiControls )
         throws DecoderException
     {
@@ -155,6 +183,12 @@ public final class JndiUtils
     }
 
 
+    /**
+     * Wraps a LDAP exception into a NaingException
+     * 
+     * @param t The original exception
+     * @throws NamingException The wrapping JNDI exception
+     */
     public static void wrap( Throwable t ) throws NamingException
     {
         if ( t instanceof NamingException )