directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758790 - in /directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model: constants/ csn/ cursor/ exception/
Date Thu, 01 Sep 2016 14:45:03 GMT
Author: elecharny
Date: Thu Sep  1 14:45:03 2016
New Revision: 1758790

URL: http://svn.apache.org/viewvc?rev=1758790&view=rev
Log:
Updated Javadocs

Modified:
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/AuthenticationLevel.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/JndiPropertyConstants.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/MetaSchemaConstants.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/PasswordPolicySchemaConstants.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SchemaConstants.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SupportedSaslMechanisms.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/Csn.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/InvalidCSNException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Cursor.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorLdapReferralException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/ListCursor.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/SetCursor.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapInvalidDnException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapReferralException.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapSchemaException.java

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/AuthenticationLevel.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/AuthenticationLevel.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/AuthenticationLevel.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/AuthenticationLevel.java
Thu Sep  1 14:45:03 2016
@@ -30,7 +30,7 @@ import org.apache.directory.api.i18n.I18
  * <li>NONE : anonymous</li>
  * <li>SIMPLE : Simple authentication</li>
  * <li>STRONG : SASL or external authentication</li>
- * <li>UNAUTHENT>A special case when just doing some auditing</li>
+ * <li>UNAUTHENT : A special case when just doing some auditing</li>
  * </ul>
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/JndiPropertyConstants.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/JndiPropertyConstants.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/JndiPropertyConstants.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/JndiPropertyConstants.java
Thu Sep  1 14:45:03 2016
@@ -24,7 +24,7 @@ package org.apache.directory.api.ldap.mo
 /**
  * This class contains all the Ldap specific properties described in the JNDI API.
  * See http://java.sun.com/j2se/1.5.0/docs/guide/jndi/jndi-ldap-gl.html
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/MetaSchemaConstants.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/MetaSchemaConstants.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/MetaSchemaConstants.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/MetaSchemaConstants.java
Thu Sep  1 14:45:03 2016
@@ -22,7 +22,7 @@ package org.apache.directory.api.ldap.mo
 
 /**
  * Apache meta schema specific constants used throughout the server.
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/PasswordPolicySchemaConstants.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/PasswordPolicySchemaConstants.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/PasswordPolicySchemaConstants.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/PasswordPolicySchemaConstants.java
Thu Sep  1 14:45:03 2016
@@ -23,7 +23,7 @@ package org.apache.directory.api.ldap.mo
 
 /**
  * The PasswordPolicy schema ObjectClasses and AttributeTypes.
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SchemaConstants.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SchemaConstants.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SchemaConstants.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SchemaConstants.java
Thu Sep  1 14:45:03 2016
@@ -23,7 +23,7 @@ package org.apache.directory.api.ldap.mo
 /**
  * A utility class where we declare all the schema objects being used by any
  * ldap server.
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SupportedSaslMechanisms.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SupportedSaslMechanisms.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SupportedSaslMechanisms.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/constants/SupportedSaslMechanisms.java
Thu Sep  1 14:45:03 2016
@@ -23,7 +23,7 @@ package org.apache.directory.api.ldap.mo
 /**
  * Contains constants used for populating the supportedSASLMechanisms 
  * in the RootDSE.
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/Csn.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/Csn.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/Csn.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/Csn.java
Thu Sep  1 14:45:03 2016
@@ -43,11 +43,11 @@ import org.slf4j.LoggerFactory;
  * 
  * The CSN syntax is :
  * <pre>
- * <CSN>            ::= <timestamp> # <changeCount> # <replicaId>
# <modifierNumber>
- * <timestamp>      ::= A GMT based time, YYYYmmddHHMMSS.uuuuuuZ
- * <changeCount>    ::= [000000-ffffff] 
- * <replicaId>      ::= [000-fff]
- * <modifierNumber> ::= [000000-ffffff]
+ * &lt;CSN&gt;            ::= &lt;timestamp&gt; # &lt;changeCount&gt;
# &lt;replicaId&gt; # &lt;modifierNumber&gt;
+ * &lt;timestamp&gt;      ::= A GMT based time, YYYYmmddHHMMSS.uuuuuuZ
+ * &lt;changeCount&gt;    ::= [000000-ffffff] 
+ * &lt;replicaId&gt;      ::= [000-fff]
+ * &lt;modifierNumber&gt; ::= [000000-ffffff]
  * </pre>
  *  
  * It distinguishes a change made on an object on a server,
@@ -121,7 +121,7 @@ public class Csn implements Comparable<C
      * Creates a new instance of SimpleCSN from a String.
      * 
      * The string format must be :
-     * &lt;timestamp> # &lt;changeCount> # &lt;replica ID> # &lt;operation
number>
+     * &lt;timestamp&gt; # &lt;changeCount&gt; # &lt;replica ID&gt;
# &lt;operation number&gt;
      *
      * @param value The String containing the CSN
      * @throws InvalidCSNException if the value doesn't contain a valid CSN

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
Thu Sep  1 14:45:03 2016
@@ -54,6 +54,8 @@ public class CsnFactory
      * Returns a new {@link Csn}.
      * Generated CSN can be duplicate if user generates CSNs more than 2G 
      * times a milliseconds.
+     * 
+     * @return The new generated CSN 
      */
     public Csn newInstance()
     {
@@ -88,6 +90,7 @@ public class CsnFactory
      * 
      * @param timestamp The timestamp to use
      * @param changeCount The change count to use
+     * @return The new generated CSN 
      */
     public Csn newInstance( long timestamp, int changeCount )
     {
@@ -99,7 +102,8 @@ public class CsnFactory
      * Generates a CSN used to purge data. Its replicaID is not associated
      * to a server. 
      * 
-     * @param expirationDate The time up to the first CSN we want to keep 
+     * @param expirationDate The time up to the first CSN we want to keep
+     * @return The new generated CSN 
      */
     public Csn newPurgeCsn( long expirationDate )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/InvalidCSNException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/InvalidCSNException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/InvalidCSNException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/InvalidCSNException.java
Thu Sep  1 14:45:03 2016
@@ -50,6 +50,9 @@ public class InvalidCSNException extends
     /**
      * Creates a new instance with the specified <tt>message</tt> and
      * <tt>cause</tt>.
+     * 
+     * @param message The message associated with the exception
+     * @param cause The root cause for this exception
      */
     public InvalidCSNException( String message, Throwable cause )
     {
@@ -59,6 +62,8 @@ public class InvalidCSNException extends
 
     /**
      * Creates a new instance with the specified <tt>message</tt>.
+     * 
+     * @param message The message associated with the exception
      */
     public InvalidCSNException( String message )
     {
@@ -68,6 +73,8 @@ public class InvalidCSNException extends
 
     /**
      * Creates a new instance with the specified <tt>cause</tt>.
+     * 
+     * @param cause The root cause for this exception
      */
     public InvalidCSNException( Throwable cause )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Cursor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Cursor.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Cursor.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Cursor.java
Thu Sep  1 14:45:03 2016
@@ -66,7 +66,10 @@ public interface Cursor<E> extends Itera
      * the argument.
      *
      * @param element the element to be positioned before
-     * @throws Exception with problems accessing the underlying btree
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor before
+     * the given element, or if this Cursor is closed 
      */
     void before( E element ) throws LdapException, CursorException;
 
@@ -83,8 +86,10 @@ public interface Cursor<E> extends Itera
      * and all elements in the dataSet are greater than the argument.
      *
      * @param element the element to be positioned after
-     * @throws Exception if there are problems positioning this cursor or if
-     * this Cursor is closed
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor after
+     * the given element, or if this Cursor is closed 
      */
     void after( E element ) throws LdapException, CursorException;
 
@@ -92,8 +97,10 @@ public interface Cursor<E> extends Itera
     /**
      * Positions this Cursor before the first element.
      *
-     * @throws Exception if there are problems positioning this cursor or if
-     * this Cursor is closed
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor before
+     * the first position, or if this Cursor is closed 
      */
     void beforeFirst() throws LdapException, CursorException;
 
@@ -101,8 +108,10 @@ public interface Cursor<E> extends Itera
     /**
      * Positions this Cursor after the last element.
      *
-     * @throws Exception if there are problems positioning this Cursor or if
-     * this Cursor is closed
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor after
+     * the last position, or if this Cursor is closed 
      */
     void afterLast() throws LdapException, CursorException;
 
@@ -112,8 +121,10 @@ public interface Cursor<E> extends Itera
      *
      * @return true if the position has been successfully changed to the first
      * element, false otherwise
-     * @throws Exception if there are problems positioning this Cursor or if
-     * this Cursor is closed
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor to
+     * the first position, or if this Cursor is closed 
      */
     boolean first() throws LdapException, CursorException;
 
@@ -123,8 +134,6 @@ public interface Cursor<E> extends Itera
      *
      * @return true if this cursor is positioned at the first element, 
      * false otherwise
-     * @throws Exception if there are problems querying the position of this Cursor
-     * or if this Cursor is closed
      */
     boolean isFirst();
 
@@ -134,8 +143,6 @@ public interface Cursor<E> extends Itera
      *
      * @return true if this cursor is positioned before the first element, 
      * false otherwise
-     * @throws Exception if there are problems querying the position of this Cursor
-     * or if this Cursor is closed
      */
     boolean isBeforeFirst();
 
@@ -145,8 +152,10 @@ public interface Cursor<E> extends Itera
      *
      * @return true if the position has been successfully changed to the last
      * element, false otherwise
-     * @throws Exception if there are problems positioning this Cursor or if
-     * this Cursor is closed
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor to
+     * the last position, or if this Cursor is closed 
      */
     boolean last() throws LdapException, CursorException;
 
@@ -156,8 +165,6 @@ public interface Cursor<E> extends Itera
      *
      * @return true if this cursor is positioned at the last element, 
      * false otherwise
-     * @throws Exception if there are problems querying the position of this Cursor
-     * or if this Cursor is closed
      */
     boolean isLast();
 
@@ -167,8 +174,6 @@ public interface Cursor<E> extends Itera
      *
      * @return true if this cursor is positioned after the last element, 
      * false otherwise
-     * @throws Exception if there are problems querying the position of this Cursor
-     * or if this Cursor is closed
      */
     boolean isAfterLast();
 
@@ -189,7 +194,10 @@ public interface Cursor<E> extends Itera
      * last element.
      *
      * @return true if the advance succeeded, false otherwise
-     * @throws Exception if there are problems advancing to the next position
+     * @throws LdapException if we have get any LDAP exception while operating
+     * the cursor
+     * @throws CursorException if there are problems advancing to this Cursor to
+     * the previous position, or if this Cursor is closed 
      */
     boolean previous() throws LdapException, CursorException;
 
@@ -205,7 +213,6 @@ public interface Cursor<E> extends Itera
      * the cursor
      * @throws CursorException if there are problems advancing to this Cursor to
      * the next position, or if this Cursor is closed 
-     * @throws IOException If we have had any IO Exception
      */
     boolean next() throws LdapException, CursorException;
 
@@ -218,7 +225,6 @@ public interface Cursor<E> extends Itera
      * @return the object at the current position
      * @throws CursorException if the object at this Cursor's current position
      * cannot be retrieved, or if this Cursor is closed
-     * @throws IOException If we have had any IO Exception
      */
     E get() throws CursorException;
 
@@ -231,6 +237,7 @@ public interface Cursor<E> extends Itera
      * CursorClosedException.
      *
      * @param reason exception thrown when this Cursor is accessed after close
+     * @throws IOException If we can't close the Cursor 
      */
     void close( Exception reason ) throws IOException;
 

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorException.java
Thu Sep  1 14:45:03 2016
@@ -53,6 +53,8 @@ public class CursorException extends Exc
 
     /**
      * Creates a new instance of LdapException.
+     * 
+     * @param cause The root cause for this exception
      */
     public CursorException( Throwable cause )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorLdapReferralException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorLdapReferralException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorLdapReferralException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/CursorLdapReferralException.java
Thu Sep  1 14:45:03 2016
@@ -43,6 +43,8 @@ public class CursorLdapReferralException
 
     /**
      * Creates a new instance of CursorClosedException.
+     * 
+     * @param ldapReferralException The associated exception
      */
     public CursorLdapReferralException( LdapReferralException ldapReferralException )
     {
@@ -53,6 +55,7 @@ public class CursorLdapReferralException
     /**
      * Creates a new instance of CursorClosedException.
      *
+     * @param ldapReferralException The associated exception
      * @param message The associated message
      */
     public CursorLdapReferralException( LdapReferralException ldapReferralException, String
message )
@@ -66,6 +69,7 @@ public class CursorLdapReferralException
     /**
      * Creates a new instance of CursorClosedException.
      *
+     * @param ldapReferralException The associated exception
      * @param message The associated message
      * @param cause The original cause
      */
@@ -80,7 +84,9 @@ public class CursorLdapReferralException
     /**
      * Always returns {@link ResultCodeEnum#REFERRAL}
      * 
-     * @see LdapException#getResultCode()
+     * @see LdapReferralException#getResultCode()
+     * 
+     * @return the underlying LdapReferral result code, if any
      */
     public ResultCodeEnum getResultCode()
     {
@@ -113,6 +119,7 @@ public class CursorLdapReferralException
 
     /**
      * Move to the next referral
+     * 
      * @return true if there is some next referral
      */
     public boolean skipReferral()

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/ListCursor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/ListCursor.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/ListCursor.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/ListCursor.java
Thu Sep  1 14:45:03 2016
@@ -147,7 +147,7 @@ public class ListCursor<E> extends Abstr
      * Creates a new ListCursor with a specific upper (exclusive) bound: the
      * lower (inclusive) bound defaults to 0. We also provide a comparator.
      *
-     * @param comparator The comparator to use for the <E> elements
+     * @param comparator The comparator to use for the &lt;E&gt; elements
      * @param list the backing for this ListCursor
      * @param end the upper bound index representing the position after the
      * last element
@@ -176,7 +176,7 @@ public class ListCursor<E> extends Abstr
      * Creates a new ListCursor with a lower (inclusive) bound: the upper
      * (exclusive) bound is the size of the list. We also provide a comparator.
      *
-     * @param comparator The comparator to use for the <E> elements
+     * @param comparator The comparator to use for the &lt;E&gt; elements
      * @param start the lower (inclusive) bound index: the position of the
      * first entry
      * @param list the backing for this ListCursor
@@ -203,7 +203,7 @@ public class ListCursor<E> extends Abstr
      * Creates a new ListCursor without specific bounds: the bounds are
      * acquired from the size of the list. We also provide a comparator.
      *
-     * @param comparator The comparator to use for the <E> elements
+     * @param comparator The comparator to use for the &lt;E&gt; elements
      * @param list the backing for this ListCursor
      */
     public ListCursor( Comparator<E> comparator, List<E> list )
@@ -226,7 +226,7 @@ public class ListCursor<E> extends Abstr
      * Creates a new ListCursor without any elements. We also provide 
      * a comparator.
      * 
-     * @param comparator The comparator to use for the <E> elements
+     * @param comparator The comparator to use for the &lt;E&gt; elements
      */
     @SuppressWarnings("unchecked")
     public ListCursor( Comparator<E> comparator )

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/SetCursor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/SetCursor.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/SetCursor.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/SetCursor.java
Thu Sep  1 14:45:03 2016
@@ -116,7 +116,7 @@ public class SetCursor<E> extends Abstra
      * Creates a new SetCursor without any elements. We also provide 
      * a comparator.
      * 
-     * @param comparator The comparator to use for the <E> elements
+     * @param comparator The comparator to use for the &lt;E&gt; elements
      */
     @SuppressWarnings("unchecked")
     public SetCursor( Comparator<E> comparator )

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
Thu Sep  1 14:45:03 2016
@@ -63,7 +63,7 @@ public class AbstractLdapReferralExcepti
     /**
      * Always returns {@link ResultCodeEnum#REFERRAL}
      * 
-     * @see LdapException#getResultCode()
+     * @return The interned ResultCode
      */
     public ResultCodeEnum getResultCode()
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapException.java
Thu Sep  1 14:45:03 2016
@@ -53,6 +53,8 @@ public class LdapException extends Excep
 
     /**
      * Creates a new instance of LdapException.
+     * 
+     * @param cause The root cause for this exception 
      */
     public LdapException( Throwable cause )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapInvalidDnException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapInvalidDnException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapInvalidDnException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapInvalidDnException.java
Thu Sep  1 14:45:03 2016
@@ -37,7 +37,9 @@ public class LdapInvalidDnException exte
 
 
     /**
-     * to be used by some special exceptions like LdapInvalidDnException
+     * To be used by some special exceptions like LdapInvalidDnException
+     * 
+     * @param message The message for this exception
      */
     public LdapInvalidDnException( String message )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapReferralException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapReferralException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapReferralException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapReferralException.java
Thu Sep  1 14:45:03 2016
@@ -87,7 +87,7 @@ public class LdapReferralException exten
     /**
      * Always returns {@link ResultCodeEnum#REFERRAL}
      * 
-     * @see LdapException#getResultCode()
+     * @return The ResultCode
      */
     public ResultCodeEnum getResultCode()
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapSchemaException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapSchemaException.java?rev=1758790&r1=1758789&r2=1758790&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapSchemaException.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapSchemaException.java
Thu Sep  1 14:45:03 2016
@@ -25,7 +25,7 @@ import org.apache.directory.api.ldap.mod
 
 /**
  * A subclass of {@link LdapException} which is used to report issues 
- * during the integrity check of the schema by the {@link SchemaManager}.
+ * during the integrity check of the schema by the SchemaManager.
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */



Mime
View raw message