directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758787 [2/3] - in /directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model: message/ message/controls/ name/ password/ schema/ schema/comparators/ schema/normalizers/ schema/parsers/ schema/regi...
Date Thu, 01 Sep 2016 14:43:02 GMT
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaManager.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaManager.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaManager.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaManager.java Thu Sep  1 14:43:01 2016
@@ -72,7 +72,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas to load
      * @return true if the schemas have been loaded and the registries is consistent
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean load( Schema... schemas ) throws LdapException;
 
@@ -88,7 +88,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas' name to load
      * @return true if the schemas have been loaded and the registries is consistent
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean load( String... schemas ) throws LdapException;
 
@@ -104,7 +104,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas to load
      * @return true if the schemas have been loaded and the registries is consistent
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadWithDeps( Schema... schemas ) throws LdapException;
 
@@ -120,7 +120,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas' name to load
      * @return true if the schemas have been loaded and the registries is consistent
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadWithDeps( String... schemas ) throws LdapException;
 
@@ -136,7 +136,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas to load, if enabled
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadRelaxed( Schema... schemas ) throws LdapException;
 
@@ -152,7 +152,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas' name to load, if enabled
      * @return true if the schemas have been loaded and the registries is consistent
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadRelaxed( String... schemas ) throws LdapException;
 
@@ -168,7 +168,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas to load
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadWithDepsRelaxed( Schema... schemas ) throws LdapException;
 
@@ -184,7 +184,7 @@ public interface SchemaManager
      * 
      * @param schemas the Schemas' name to load
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadWithDepsRelaxed( String... schemas ) throws LdapException;
 
@@ -199,7 +199,7 @@ public interface SchemaManager
      *
      * @param schemas The Schemas to load
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadDisabled( Schema... schemas ) throws LdapException;
 
@@ -214,7 +214,7 @@ public interface SchemaManager
      *
      * @param schemas The Schemas' name to load
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO 
+     * @throws LdapException If something went wrong
      */
     boolean loadDisabled( String... schemas ) throws LdapException;
 
@@ -224,7 +224,7 @@ public interface SchemaManager
      * any inconsistent schema will be rejected. 
      *
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO
+     * @throws LdapException If something went wrong
      */
     boolean loadAllEnabled() throws LdapException;
 
@@ -234,7 +234,7 @@ public interface SchemaManager
      * even inconsistent schema will be loaded. 
      *
      * @return true if the schemas have been loaded
-     * @throws LdapException @TODO
+     * @throws LdapException If something went wrong
      */
     boolean loadAllEnabledRelaxed() throws LdapException;
 
@@ -244,6 +244,7 @@ public interface SchemaManager
      *
      * @param schemas The list of Schema to unload
      * @return True if all the schemas have been unloaded
+     * @throws LdapException If something went wrong
      */
     boolean unload( Schema... schemas ) throws LdapException;
 
@@ -253,6 +254,7 @@ public interface SchemaManager
      *
      * @param schemas The list of Schema to unload
      * @return True if all the schemas have been unloaded
+     * @throws LdapException If something went wrong
      */
     boolean unload( String... schemas ) throws LdapException;
 
@@ -267,9 +269,9 @@ public interface SchemaManager
      * 
      * If the modification is ok, the Registries will be updated. 
      * 
-     *  @param schemas The list of schemas to enable
-     *  @return true if the Registries is still consistent, false otherwise.
-     *  @throws If something went wrong
+     * @param schemas The list of schemas to enable
+     * @return true if the Registries is still consistent, false otherwise.
+     * @throws LdapException If something went wrong
      */
     boolean enable( Schema... schemas ) throws LdapException;
 
@@ -281,9 +283,9 @@ public interface SchemaManager
      * 
      * If the modification is ok, the Registries will be updated.
      *  
-     *  @param schemas The list of schema name to enable
-     *  @return true if the Registries is still consistent, false otherwise.
-     *  @throws If something went wrong
+     * @param schemas The list of schema name to enable
+     * @return true if the Registries is still consistent, false otherwise.
+     * @throws LdapException If something went wrong
      */
     boolean enable( String... schemas ) throws LdapException;
 
@@ -293,8 +295,8 @@ public interface SchemaManager
      * enabled, with all the dependent schemas. No check is done, the Registries
      * might become inconsistent after this operation.
      * 
-     *  @param schemas The list of schemas to enable
-     *  @return true if all the schemas have been enabled
+     * @param schemas The list of schemas to enable
+     * @return true if all the schemas have been enabled
      */
     boolean enableRelaxed( Schema... schemas );
 
@@ -304,8 +306,8 @@ public interface SchemaManager
      * enabled, with all the dependent schemas. No check is done, the Registries
      * might become inconsistent after this operation.
      * 
-     *  @param schemas The list of schema names to enable
-     *  @return true if all the schemas have been enabled
+     * @param schemas The list of schema names to enable
+     * @return true if all the schemas have been enabled
      */
     boolean enableRelaxed( String... schemas );
 
@@ -349,7 +351,7 @@ public interface SchemaManager
      * 
      *  @param schemas The list of schemas to disable
      *  @return true if the Registries is still consistent, false otherwise.
-     *  @throws If something went wrong
+     *  @throws LdapException If something went wrong
      */
     boolean disable( Schema... schemas ) throws LdapException;
 
@@ -363,7 +365,7 @@ public interface SchemaManager
      * 
      *  @param schemas The list of schema names to disable
      *  @return true if the Registries is still consistent, false otherwise.
-     *  @throws If something went wrong
+     *  @throws LdapException If something went wrong
      */
     boolean disable( String... schemas ) throws LdapException;
 
@@ -735,6 +737,7 @@ public interface SchemaManager
      * 
      * @param attributeTypeOid the attributeType OID to unregister
      * @throws LdapException if the attributeType is invalid
+     * @return the unregistred AtttributeType
      */
     SchemaObject unregisterAttributeType( String attributeTypeOid ) throws LdapException;
 
@@ -744,6 +747,7 @@ public interface SchemaManager
      * 
      * @param comparatorOid the Comparator OID to unregister
      * @throws LdapException if the Comparator is invalid
+     * @return the unregistred Comparator
      */
     SchemaObject unregisterComparator( String comparatorOid ) throws LdapException;
 
@@ -753,6 +757,7 @@ public interface SchemaManager
      * 
      * @param ditControlRuleOid the DitControlRule OID to unregister
      * @throws LdapException if the DitControlRule is invalid
+     * @return the unregistred DitControlRule
      */
     SchemaObject unregisterDitControlRule( String ditControlRuleOid ) throws LdapException;
 
@@ -762,6 +767,7 @@ public interface SchemaManager
      * 
      * @param ditStructureRuleOid the DitStructureRule OID to unregister
      * @throws LdapException if the DitStructureRule is invalid
+     * @return the unregistred DitStructureRule
      */
     SchemaObject unregisterDitStructureRule( String ditStructureRuleOid ) throws LdapException;
 
@@ -771,6 +777,7 @@ public interface SchemaManager
      * 
      * @param matchingRuleOid the MatchingRuleRule OID to unregister
      * @throws LdapException if the MatchingRule is invalid
+     * @return the unregistred MatchingRule
      */
     SchemaObject unregisterMatchingRule( String matchingRuleOid ) throws LdapException;
 
@@ -780,6 +787,7 @@ public interface SchemaManager
      * 
      * @param matchingRuleUseOid the MatchingRuleUse OID to unregister
      * @throws LdapException if the MatchingRuleUse is invalid
+     * @return the unregistred MatchingRuleUse
      */
     SchemaObject unregisterMatchingRuleUse( String matchingRuleUseOid ) throws LdapException;
 
@@ -789,6 +797,7 @@ public interface SchemaManager
      * 
      * @param nameFormOid the NameForm OID to unregister
      * @throws LdapException if the NameForm is invalid
+     * @return the unregistred NameForm
      */
     SchemaObject unregisterNameForm( String nameFormOid ) throws LdapException;
 
@@ -798,6 +807,7 @@ public interface SchemaManager
      * 
      * @param normalizerOid the Normalizer OID to unregister
      * @throws LdapException if the Normalizer is invalid
+     * @return the unregistred Normalizer
      */
     SchemaObject unregisterNormalizer( String normalizerOid ) throws LdapException;
 
@@ -807,6 +817,7 @@ public interface SchemaManager
      * 
      * @param objectClassOid the ObjectClass OID to unregister
      * @throws LdapException if the ObjectClass is invalid
+     * @return the unregistred ObjectClass
      */
     SchemaObject unregisterObjectClass( String objectClassOid ) throws LdapException;
 
@@ -816,6 +827,7 @@ public interface SchemaManager
      * 
      * @param ldapSyntaxOid the LdapSyntax OID to unregister
      * @throws LdapException if the LdapSyntax is invalid
+     * @return the unregistred Syntax
      */
     SchemaObject unregisterLdapSyntax( String ldapSyntaxOid ) throws LdapException;
 
@@ -825,6 +837,7 @@ public interface SchemaManager
      * 
      * @param syntaxCheckerOid the SyntaxChecker OID to unregister
      * @throws LdapException if the SyntaxChecker is invalid
+     * @return the unregistred SyntaxChecker
      */
     SchemaObject unregisterSyntaxChecker( String syntaxCheckerOid ) throws LdapException;
 

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObject.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObject.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObject.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObject.java Thu Sep  1 14:43:01 2016
@@ -28,36 +28,42 @@ import java.util.Map;
  * Most schema objects have some common attributes. This class
  * contains the minimum set of properties exposed by a SchemaObject.<br>
  * We have 11 types of SchemaObjects :
- * <li> AttributeType
- * <li> DitCOntentRule
- * <li> DitStructureRule
- * <li> LdapComparator (specific to ADS)
- * <li> LdapSyntaxe
- * <li> MatchingRule
- * <li> MatchingRuleUse
- * <li> NameForm
- * <li> Normalizer (specific to ADS)
- * <li> ObjectClass
- * <li> SyntaxChecker (specific to ADS)
+ * <ul>
+ *   <li> AttributeType </li>
+ *   <li> DitCOntentRule </li>
+ *   <li> DitStructureRule </li>
+ *   <li> LdapComparator (specific to ADS) </li>
+ *   <li> LdapSyntaxe </li>
+ *   <li> MatchingRule </li>
+ *   <li> MatchingRuleUse </li>
+ *   <li> NameForm </li>
+ *   <li> Normalizer (specific to ADS) </li>
+ *   <li> ObjectClass </li>
+ *   <li> SyntaxChecker (specific to ADS) </li>
+ * </ul>
  * <br>
  * <br>
  * This class provides accessors and setters for the following attributes,
  * which are common to all those SchemaObjects :
- * <li>oid : The numeric OID
- * <li>description : The SchemaObject description
- * <li>obsolete : Tells if the schema object is obsolete
- * <li>extensions : The extensions, a key/Values map
- * <li>schemaObjectType : The SchemaObject type (see upper)
- * <li>schema : The schema the SchemaObject is associated with (it's an extension).
- * Can be null
- * <li>isEnabled : The SchemaObject status (it's related to the schema status)
- * <li>isReadOnly : Tells if the SchemaObject can be modified or not
+ * <ul>
+ *   <li>oid : The numeric OID </li>
+ *   <li>description : The SchemaObject description </li>
+ *   <li>obsolete : Tells if the schema object is obsolete </li>
+ *   <li>extensions : The extensions, a key/Values map </li>
+ *   <li>schemaObjectType : The SchemaObject type (see upper) </li>
+ *   <li>schema : The schema the SchemaObject is associated with (it's an extension).
+ *   Can be null </li>
+ *   <li>isEnabled : The SchemaObject status (it's related to the schema status) </li>
+ *   <li>isReadOnly : Tells if the SchemaObject can be modified or not </li>
+ * </ul>
  * <br><br>
  * Some of those attributes are not used by some Schema elements, even if they should
  * have been used. Here is the list :
- * <b>name</b> : LdapSyntax, Comparator, Normalizer, SyntaxChecker
- * <b>numericOid</b> : DitStructureRule,
- * <b>obsolete</b> : LdapSyntax, Comparator, Normalizer, SyntaxChecker
+ * <ul>
+ *   <li><b>name</b> : LdapSyntax, Comparator, Normalizer, SyntaxChecker</li>
+ *   <li><b>numericOid</b> : DitStructureRule</li>
+ *   <li><b>obsolete</b> : LdapSyntax, Comparator, Normalizer, SyntaxChecker</li>
+ * </ul>
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public interface SchemaObject
@@ -262,17 +268,19 @@ public interface SchemaObject
 
     /**
      * The SchemaObject type :
-     * <li> AttributeType
-     * <li> DitCOntentRule
-     * <li> DitStructureRule
-     * <li> LdapComparator (specific to ADS)
-     * <li> LdapSyntaxe
-     * <li> MatchingRule
-     * <li> MatchingRuleUse
-     * <li> NameForm
-     * <li> Normalizer (specific to ADS)
-     * <li> ObjectClass
-     * <li> SyntaxChecker (specific to ADS)
+     * <ul>
+     *   <li> AttributeType</li>
+     *   <li> DitCOntentRule</li>
+     *   <li> DitStructureRule</li>
+     *   <li> LdapComparator (specific to ADS)</li>
+     *   <li> LdapSyntaxe</li>
+     *   <li> MatchingRule</li>
+     *   <li> MatchingRuleUse</li>
+     *   <li> NameForm</li>
+     *   <li> Normalizer (specific to ADS)</li>
+     *   <li> ObjectClass</li>
+     *   <li> SyntaxChecker (specific to ADS)</li>
+     * </ul>
      * 
      * @return the SchemaObject type
      */
@@ -335,6 +343,8 @@ public interface SchemaObject
 
     /**
      * Transform the SchemaObject to an immutable object
+     * TODO locked.
+     *
      */
     void lock();
 }

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java Thu Sep  1 14:43:01 2016
@@ -206,8 +206,6 @@ public final class SchemaObjectRenderer
      * </pre>
      * @param at the AttributeType to render the description for
      * @return the StringBuffer containing the rendered attributeType description
-     * @throws LdapException if there are problems accessing the objects
-     * associated with the attribute type.
      */
     public String render( AttributeType at )
     {
@@ -362,8 +360,6 @@ public final class SchemaObjectRenderer
      * </pre>
      * @param mr the MatchingRule to render the description for
      * @return the StringBuffer containing the rendered matchingRule description
-     * @throws LdapException if there are problems accessing the objects
-     * associated with the MatchingRule.
      */
     public String render( MatchingRule mr )
     {
@@ -445,6 +441,10 @@ public final class SchemaObjectRenderer
 
     /**
      * NOT FULLY IMPLEMENTED!
+     * Renders a MatchingRuleUse as a String
+     * 
+     * @param mru The MatchingRuleUse to render
+     * @return The MatchingRuleUse as a String
      */
     public String render( MatchingRuleUse mru )
     {
@@ -473,6 +473,10 @@ public final class SchemaObjectRenderer
 
     /**
      * NOT FULLY IMPLEMENTED!
+     * Renders a DitContentRule as a String
+     * 
+     * @param dcr The DitContentRule to render
+     * @return The DitContentRule as a String
      */
     public String render( DitContentRule dcr )
     {
@@ -499,6 +503,9 @@ public final class SchemaObjectRenderer
 
     /**
      * NOT FULLY IMPLEMENTED!
+     * 
+     * @param dsr The DitStructureRule to render
+     * @return The DitStructureRule as a String
      */
     public String render( DitStructureRule dsr )
     {
@@ -536,6 +543,10 @@ public final class SchemaObjectRenderer
 
     /**
      * NOT FULLY IMPLEMENTED!
+     * Render a NameForm as a String
+     * 
+     * @param nf The NameForm to render
+     * @return The rendered String
      */
     public String render( NameForm nf )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java Thu Sep  1 14:43:01 2016
@@ -365,10 +365,10 @@ public final class SchemaUtils
     // ------------------------------------------------------------------------
 
     /**
-     * Renders the schema extensions into a new StringBuilder.
+     * Renders the schema extensions into a new StringBuffer.
      *
      * @param extensions the schema extensions map with key and values
-     * @return a StringBuilder with the extensions component of a syntax description
+     * @return a StringBuffer with the extensions component of a syntax description
      */
     public static StringBuilder render( Map<String, List<String>> extensions )
     {
@@ -420,10 +420,10 @@ public final class SchemaUtils
     /**
      * Returns a String description of a schema. The resulting String format is :
      * <br>
-     * (OID [DESC '<description>'] FQCN <fcqn> [BYTECODE <bytecode>] X-SCHEMA '<schema>')
+     * (OID [DESC '&lt;description&gt;'] FQCN &lt;fcqn&gt; [BYTECODE &lt;bytecode&gt;] X-SCHEMA '&lt;schema&gt;')
      * <br>
      * @param description The description to transform to a String
-     * @return
+     * @return The rendered schema object
      */
     public static String render( LoadableSchemaObject description )
     {
@@ -466,12 +466,17 @@ public final class SchemaUtils
 
     /**
      * Remove the options from the attributeType, and returns the ID.
-     * 
+     * <br>
      * RFC 4512 :
+     * <pre>
      * attributedescription = attributetype options
      * attributetype = oid
      * options = *( SEMI option )
      * option = 1*keychar
+     * </pre>
+     * 
+     * @param attributeId The AttributeType to parse
+     * @return The AttributeType without its options
      */
     public static String stripOptions( String attributeId )
     {
@@ -490,11 +495,14 @@ public final class SchemaUtils
 
     /**
      * Get the options from the attributeType.
-     * 
+     * <br>
      * For instance, given :
      * jpegphoto;binary;lang=jp
-     * 
+     * <br>
      * your get back a set containing { "binary", "lang=jp" }
+     * 
+     * @param attributeId The AttributeType to parse
+     * @return a Set of options found for this AttributeType, or null
      */
     public static Set<String> getOptions( String attributeId )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BitStringComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BitStringComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BitStringComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BitStringComparator.java Thu Sep  1 14:43:01 2016
@@ -42,6 +42,8 @@ public class BitStringComparator extends
     /**
      * The BitStringComparator constructor. Its OID is the IntegerOrderingMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public BitStringComparator( String oid )
     {
@@ -50,7 +52,7 @@ public class BitStringComparator extends
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     public int compare( String bs1, String bs2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BooleanComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BooleanComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BooleanComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/BooleanComparator.java Thu Sep  1 14:43:01 2016
@@ -42,6 +42,8 @@ public class BooleanComparator extends L
     /**
      * The BooleanComparator constructor. Its OID is the BooleanMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public BooleanComparator( String oid )
     {
@@ -50,7 +52,7 @@ public class BooleanComparator extends L
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     public int compare( String b1, String b2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ByteArrayComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ByteArrayComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ByteArrayComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ByteArrayComparator.java Thu Sep  1 14:43:01 2016
@@ -37,6 +37,8 @@ public class ByteArrayComparator extends
     /**
      * The ByteArrayComparator constructor. Its OID is the OctetStringMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public ByteArrayComparator( String oid )
     {
@@ -45,7 +47,7 @@ public class ByteArrayComparator extends
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( byte[] b1, byte[] b2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CertificateComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CertificateComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CertificateComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CertificateComparator.java Thu Sep  1 14:43:01 2016
@@ -30,6 +30,8 @@ public class CertificateComparator exten
 {
     /**
      * Creates a new instance of CertificateComparator.
+     * 
+     * @param oid The Comparator's OID
      */
     public CertificateComparator( String oid )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnComparator.java Thu Sep  1 14:43:01 2016
@@ -49,6 +49,8 @@ public class CsnComparator extends LdapC
     /**
      * The CsnComparator constructor. Its OID is the CsnMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public CsnComparator( String oid )
     {
@@ -57,7 +59,7 @@ public class CsnComparator extends LdapC
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     @Override
     public int compare( Object csnObj1, Object csnObj2 )

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnSidComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnSidComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnSidComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/CsnSidComparator.java Thu Sep  1 14:43:01 2016
@@ -44,6 +44,8 @@ public class CsnSidComparator extends Ld
     /**
      * The CsnSidComparator constructor. Its OID is the CsnSidMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public CsnSidComparator( String oid )
     {
@@ -52,7 +54,7 @@ public class CsnSidComparator extends Ld
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( String sidStr1, String sidStr2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimComparator.java Thu Sep  1 14:43:01 2016
@@ -42,6 +42,8 @@ public class DeepTrimComparator extends
     
     /**
      * The NormalizingComparator constructor. Its OID is the  matching rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public DeepTrimComparator( String oid )
     {
@@ -51,8 +53,7 @@ public class DeepTrimComparator extends
 
 
     /**
-     * If any normalization attempt fails we compare using the unnormalized
-     * object.
+     * {@inheritDoc}
      */
     public int compare( String o1, String o2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimToLowerComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimToLowerComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimToLowerComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DeepTrimToLowerComparator.java Thu Sep  1 14:43:01 2016
@@ -43,6 +43,8 @@ public class DeepTrimToLowerComparator e
 
     /**
      * The NormalizingComparator constructor. Its OID is the  matching rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public DeepTrimToLowerComparator( String oid )
     {
@@ -52,8 +54,7 @@ public class DeepTrimToLowerComparator e
 
 
     /**
-     * If any normalization attempt fails we compare using the unnormalized
-     * object.
+     * {@inheritDoc}
      */
     public int compare( String key, String value )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java Thu Sep  1 14:43:01 2016
@@ -41,6 +41,11 @@ public class DnComparator extends LdapCo
     /** A reference to the schema manager */
     private transient SchemaManager schemaManager;
 
+    /**
+     * Creates a new instance of DnComparator.
+     * 
+     * @param oid The Comparator's OID
+     */
     public DnComparator( String oid )
     {
         super( oid );

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/GeneralizedTimeComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/GeneralizedTimeComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/GeneralizedTimeComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/GeneralizedTimeComparator.java Thu Sep  1 14:43:01 2016
@@ -46,6 +46,8 @@ public class GeneralizedTimeComparator e
     /**
      * The GeneralizedTimeComparator constructor. Its OID is the
      * generalizedTimeOrderingMatch matching rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public GeneralizedTimeComparator( String oid )
     {
@@ -54,7 +56,7 @@ public class GeneralizedTimeComparator e
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     public int compare( String backendValue, String assertValue )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/IntegerComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/IntegerComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/IntegerComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/IntegerComparator.java Thu Sep  1 14:43:01 2016
@@ -49,6 +49,8 @@ public class IntegerComparator extends L
     /**
      * The IntegerComparator constructor. Its OID is the IntegerOrderingMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public IntegerComparator( String oid )
     {
@@ -57,7 +59,7 @@ public class IntegerComparator extends L
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     @Override
     public int compare( Object v1, Object v2 )

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/LongComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/LongComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/LongComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/LongComparator.java Thu Sep  1 14:43:01 2016
@@ -40,6 +40,8 @@ public class LongComparator extends Ldap
     /**
      * The LongComparator constructor. Its OID is the IntegerOrderingMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public LongComparator( String oid )
     {
@@ -48,11 +50,7 @@ public class LongComparator extends Ldap
 
 
     /**
-     * Compare two objects.
-     * 
-     * @param obj1 First object
-     * @param obj2 Second object
-     * @return 1 if obj1 > obj2, 0 if obj1 == obj2, -1 if obj1 < obj2
+     * {@inheritDoc}
      */
     public int compare( Long obj1, Long obj2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NormalizingComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NormalizingComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NormalizingComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NormalizingComparator.java Thu Sep  1 14:43:01 2016
@@ -49,6 +49,8 @@ public class NormalizingComparator exten
 
     /**
      * The NormalizingComparator constructor. Its OID is the  matching rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public NormalizingComparator( String oid )
     {
@@ -59,6 +61,7 @@ public class NormalizingComparator exten
     /**
      * A comparator which normalizes a value first before comparing them.
      * 
+     * @param oid The Comparator's OID
      * @param normalizer the Normalizer to normalize values with before comparing
      * @param comparator the underlying comparator to use for comparisons
      */
@@ -71,8 +74,7 @@ public class NormalizingComparator exten
 
 
     /**
-     * If any normalization attempt fails we compare using the unnormalized
-     * object.
+     * {@inheritDoc}
      */
     public int compare( String o1, String o2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NumericStringComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NumericStringComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NumericStringComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/NumericStringComparator.java Thu Sep  1 14:43:01 2016
@@ -46,6 +46,8 @@ public class NumericStringComparator ext
     /**
      * The IntegerComparator constructor. Its OID is the numericStringOrderingMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public NumericStringComparator( String oid )
     {
@@ -54,7 +56,7 @@ public class NumericStringComparator ext
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     public int compare( String backendValue, String assertValue )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java Thu Sep  1 14:43:01 2016
@@ -36,6 +36,11 @@ public class ObjectClassTypeComparator<T
     private static final long serialVersionUID = 2L;
 
 
+    /**
+     * Creates a new instance of ObjectClassTypeComparator.
+     * 
+     * @param oid The Comparator's OID
+     */
     public ObjectClassTypeComparator( String oid )
     {
         super( oid );

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierComparator.java Thu Sep  1 14:43:01 2016
@@ -42,6 +42,8 @@ public class ObjectIdentifierComparator
     /**
      * The ObjectIdentifierComparator constructor. Its OID is the ObjectIdentifierMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public ObjectIdentifierComparator( String oid )
     {
@@ -50,7 +52,7 @@ public class ObjectIdentifierComparator
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     @Override
     public int compare( Object o1, Object o2 )

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierFirstComponentComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierFirstComponentComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierFirstComponentComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectIdentifierFirstComponentComparator.java Thu Sep  1 14:43:01 2016
@@ -45,6 +45,8 @@ public class ObjectIdentifierFirstCompon
     /**
      * The ObjectIdentifierFirstComponentComparator constructor. Its OID is the 
      * ObjectIdentifierFirstComponentMatch matching rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public ObjectIdentifierFirstComponentComparator( String oid )
     {
@@ -91,7 +93,7 @@ public class ObjectIdentifierFirstCompon
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( String s1, String s2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ParsedDnComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ParsedDnComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ParsedDnComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ParsedDnComparator.java Thu Sep  1 14:43:01 2016
@@ -41,6 +41,11 @@ public class ParsedDnComparator extends
     /** A reference to the schema manager */
     private transient SchemaManager schemaManager;
 
+    /**
+     * The ParsedDnComparator constructor.
+     * 
+     * @param oid The Comparator's OID
+     */
     public ParsedDnComparator( String oid )
     {
         super( oid );

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java Thu Sep  1 14:43:01 2016
@@ -63,12 +63,8 @@ public class SerializableComparator<E> e
     }
 
 
-    // ------------------------------------------------------------------------
-    // C O M P A R A T O R   I M P L E M E N T A T I O N S
-    // ------------------------------------------------------------------------
-
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     @SuppressWarnings("unchecked")
     @Override

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/StringComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/StringComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/StringComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/StringComparator.java Thu Sep  1 14:43:01 2016
@@ -44,6 +44,8 @@ public class StringComparator extends Ld
     /**
      * The StringComparator constructor. Its OID is the StringMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public StringComparator( String oid )
     {
@@ -52,7 +54,7 @@ public class StringComparator extends Ld
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( String s1, String s2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/TelephoneNumberComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/TelephoneNumberComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/TelephoneNumberComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/TelephoneNumberComparator.java Thu Sep  1 14:43:01 2016
@@ -45,6 +45,8 @@ public class TelephoneNumberComparator e
     /**
      * The TelephoneNumberComparator constructor. Its OID is the TelephoneNumberMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public TelephoneNumberComparator( String oid )
     {
@@ -75,7 +77,7 @@ public class TelephoneNumberComparator e
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( String telephoneNumber1, String telephoneNumber2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java Thu Sep  1 14:43:01 2016
@@ -47,6 +47,8 @@ public class UniqueMemberComparator exte
     /**
      * The IntegerComparator constructor. Its OID is the IntegerOrderingMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public UniqueMemberComparator( String oid )
     {
@@ -55,7 +57,7 @@ public class UniqueMemberComparator exte
 
 
     /**
-     * Implementation of the Compare method
+     * {@inheritDoc}
      */
     public int compare( String dnstr1, String dnstr2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java Thu Sep  1 14:43:01 2016
@@ -46,6 +46,8 @@ public class UuidComparator extends Seri
     /**
      * The UUIDComparator constructor. Its OID is the UUIDMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public UuidComparator( String oid )
     {
@@ -54,7 +56,7 @@ public class UuidComparator extends Seri
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     @Override
     public int compare( String uuid1, String uuid2 )
@@ -77,7 +79,7 @@ public class UuidComparator extends Seri
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( UUID uuid1, UUID uuid2 )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/WordComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/WordComparator.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/WordComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/WordComparator.java Thu Sep  1 14:43:01 2016
@@ -56,6 +56,8 @@ public class WordComparator extends Ldap
     /**
      * The StringComparator constructor. Its OID is the StringMatch matching
      * rule OID.
+     * 
+     * @param oid The Comparator's OID
      */
     public WordComparator( String oid )
     {
@@ -64,7 +66,7 @@ public class WordComparator extends Ldap
 
 
     /**
-     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+     * {@inheritDoc}
      */
     public int compare( String value, String assertion )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/DnNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/DnNormalizer.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/DnNormalizer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/DnNormalizer.java Thu Sep  1 14:43:01 2016
@@ -77,7 +77,7 @@ public class DnNormalizer extends Normal
      * Normalize a Dn
      * @param value The Dn to normalize
      * @return A normalized Dn
-     * @throws LdapException
+     * @throws LdapException If the DN is invalid
      */
     public String normalize( Dn value ) throws LdapException
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java Thu Sep  1 14:43:01 2016
@@ -70,6 +70,8 @@ public abstract class AbstractSchemaPars
 
     /**
      * Instantiates a new abstract schema parser.
+     * 
+     * @param schemaObjectType The Schema object type
      * @param errorCodeOnNull error code used when schema element is null
      * @param errorCodeOnParseExceptionWithPosition error code used on parse error when position is known
      * @param errorCodeOnParseException error code used on parse error when position is unknown

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/AttributeTypeRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/AttributeTypeRegistry.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/AttributeTypeRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/AttributeTypeRegistry.java Thu Sep  1 14:43:01 2016
@@ -99,7 +99,8 @@ public interface AttributeTypeRegistry e
      * descendants.
      * 
      * @param attributeType The attributeType to register
-     * @throws org.apache.directory.api.ldap.model.exception.LdapException If something went wrong
+     * @param ancestor The attributeType's parent
+     * @throws LdapException If something went wrong
      */
     void registerDescendants( AttributeType attributeType, AttributeType ancestor ) throws LdapException;
 
@@ -117,18 +118,26 @@ public interface AttributeTypeRegistry e
 
     /**
      * Add a new Oid/Normalizer couple in the OidNormalizer map
+     * 
+     * @param attributeType The AttributeType to add
+     * @throws LdapException If something went wrong
      */
     void addMappingFor( AttributeType attributeType ) throws LdapException;
 
 
     /**
      * Remove a new Oid/Normalizer couple in the OidNormalizer map
+     * 
+     * @param attributeType The AttributeType to remove
+     * @throws LdapException If something went wrong
      */
     void removeMappingFor( AttributeType attributeType ) throws LdapException;
 
 
     /**
      * Copy the AttributeTypeRegistry
+     * 
+     * @return The copied AttributeTypeRegistry
      */
     @Override
     AttributeTypeRegistry copy();

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchema.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchema.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchema.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchema.java Thu Sep  1 14:43:01 2016
@@ -61,6 +61,7 @@ public class DefaultSchema implements Sc
     /**
      * Creates a new instance of DefaultSchema.
      *
+     * @param schemaLoader The ShcemaLoader to use
      * @param name The schema's name
      */
     public DefaultSchema( SchemaLoader schemaLoader, String name )
@@ -72,6 +73,7 @@ public class DefaultSchema implements Sc
     /**
      * Creates a new instance of DefaultSchema.
      *
+     * @param schemaLoader The ShcemaLoader to use
      * @param name The schema's name
      * @param owner the schema's owner
      */
@@ -84,6 +86,7 @@ public class DefaultSchema implements Sc
     /**
      * Creates a new instance of DefaultSchema.
      *
+     * @param schemaLoader The ShcemaLoader to use
      * @param name The schema's name
      * @param owner the schema's owner
      * @param dependencies The list of schemas it depends on 
@@ -97,6 +100,7 @@ public class DefaultSchema implements Sc
     /**
      * Creates a new instance of DefaultSchema.
      *
+     * @param schemaLoader The ShcemaLoader to use
      * @param name The schema's name
      * @param owner the schema's owner
      * @param dependencies The list of schemas it depends on

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java Thu Sep  1 14:43:01 2016
@@ -66,6 +66,9 @@ public abstract class DefaultSchemaObjec
 
     /**
      * Creates a new DefaultSchemaObjectRegistry instance.
+     * 
+     * @param schemaObjectType The Schema Object type
+     * @param oidRegistry The OID registry to use
      */
     protected DefaultSchemaObjectRegistry( SchemaObjectType schemaObjectType, OidRegistry<T> oidRegistry )
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java Thu Sep  1 14:43:01 2016
@@ -220,6 +220,7 @@ public class OidRegistry<T extends Schem
      * Adds an OID name pair to the registry.
      * 
      * @param schemaObject The SchemaObject the oid belongs to
+     * @throws LdapException If something went wrong
      */
     public void register( T schemaObject ) throws LdapException
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java Thu Sep  1 14:43:01 2016
@@ -444,17 +444,21 @@ public class Registries implements Schem
      * refer to other objects within the registries.  Null references will be
      * handed appropriately.
      * The order in which the SchemaObjects must be :
-     * <li/>1) Normalizers, Comparators and SyntaxCheckers (as they depend on nothing)
-     * <li/>2) Syntaxes (depend on SyntaxCheckers)
-     * <li/>3) MatchingRules (depend on Syntaxes, Normalizers and Comparators
-     * <li/>4) AttributeTypes (depend on MatchingRules, Syntaxes and AttributeTypes : in this case, we first handle the superior)
-     * <li/>5) ObjectClasses (depend on AttributeTypes and ObjectClasses)
-     * <br/><br/>
+     * <ul>
+     *   <li>1) Normalizers, Comparators and SyntaxCheckers (as they depend on nothing)</li>
+     *   <li>2) Syntaxes (depend on SyntaxCheckers)</li>
+     *   <li>3) MatchingRules (depend on Syntaxes, Normalizers and Comparators</li>
+     *   <li>4) AttributeTypes (depend on MatchingRules, Syntaxes and AttributeTypes : in this case, we first handle the superior)</li>
+     *   <li>5) ObjectClasses (depend on AttributeTypes and ObjectClasses)</li>
+     * </ul>
+     * <br><br>
      * Later, when we will support them :
-     * <li/>6) MatchingRuleUses (depend on matchingRules and AttributeTypes)
-     * <li/>7) DitContentRules (depend on ObjectClasses and AttributeTypes)
-     * <li/>8) NameForms (depends on ObjectClasses and AttributeTypes)
-     * <li/>9) DitStructureRules (depends onNameForms and DitStructureRules)      *
+     * <ul>
+     *   <li>6) MatchingRuleUses (depend on matchingRules and AttributeTypes)</li>
+     *   <li>7) DitContentRules (depend on ObjectClasses and AttributeTypes)</li>
+     *   <li>8) NameForms (depends on ObjectClasses and AttributeTypes)</li>
+     *   <li>9) DitStructureRules (depends onNameForms and DitStructureRules)</li>
+     * </ul>
      *
      * @return a list of exceptions encountered while resolving entities
      */
@@ -529,9 +533,11 @@ public class Registries implements Schem
     
     /**
      * Delete the AT references (using and usedBy) :
-     * AT -> MR (for EQUALITY, ORDERING and SUBSTR)
-     * AT -> S
-     * AT -> AT
+     * AT -&gt; MR (for EQUALITY, ORDERING and SUBSTR)
+     * AT -&gt; S
+     * AT -&gt; AT
+     * 
+     * @param attributeType The AttributeType to remove
      */
     public void delCrossReferences( AttributeType attributeType )
     {
@@ -616,9 +622,11 @@ public class Registries implements Schem
 
     /**
      * Delete the MR references (using and usedBy) :
-     * MR -> C
-     * MR -> N
-     * MR -> S
+     * MR -&gt; C
+     * MR -&gt; N
+     * MR -&gt; S
+     * 
+     * @param matchingRule The MatchinRule refere ce to delete
      */
     public void delCrossReferences( MatchingRule matchingRule )
     {
@@ -641,6 +649,9 @@ public class Registries implements Schem
 
     /**
      * Build the SchemaObject references
+     * 
+     * @param errors The List that collect errors
+     * @param schemaObject The SchemaObject to add
      */
     public void buildReference( List<Throwable> errors, SchemaObject schemaObject )
     {
@@ -704,6 +715,9 @@ public class Registries implements Schem
 
     /**
      * Unlink the SchemaObject references
+     * 
+     * @param errors The List that collect errors
+     * @param schemaObject The SchemaObject to remove
      */
     public void removeReference( List<Throwable> errors, SchemaObject schemaObject )
     {
@@ -1330,6 +1344,12 @@ public class Registries implements Schem
 
     /**
      * Applies the added SchemaObject to the given register
+     *
+     * @param errors The list of collected errors
+     * @param schemaObject The SchemaObject to add
+     * @param check A flag set when we want the schema checks to be done
+     * @return The list of found errors
+     * @throws LdapException If we weren't able to add the SchemaObject
      */
     public List<Throwable> add( List<Throwable> errors, SchemaObject schemaObject, boolean check ) throws LdapException
     {
@@ -1373,6 +1393,11 @@ public class Registries implements Schem
 
     /**
      * Remove the given SchemaObject from the registries
+     * 
+     * @param errors The list of collected errors
+     * @param schemaObject The SchemaObject to delete
+     * @return The list of errors
+     * @throws LdapException If the deletion failed
      */
     public List<Throwable> delete( List<Throwable> errors, SchemaObject schemaObject ) throws LdapException
     {
@@ -1501,6 +1526,7 @@ public class Registries implements Schem
      * Create a new schema association with its content
      *
      * @param schemaName The schema name
+     * @return A set containing the associations
      */
     public Set<SchemaObjectWrapper> addSchema( String schemaName )
     {
@@ -1596,8 +1622,8 @@ public class Registries implements Schem
      * Store the given SchemaObject in the Map associating SchemaObjetcs to their
      * related Schema.
      *
+     * @param errors The list of errors we are accumulating while checking the schema
      * @param schemaObject The schemaObject to register
-     * @throws LdapException If there is a problem
      */
     public void associateWithSchema( List<Throwable> errors, SchemaObject schemaObject )
     {
@@ -1663,6 +1689,7 @@ public class Registries implements Schem
      * Store the given SchemaObject in the Map associating SchemaObjetcs to their
      * related Schema.
      *
+     * @param errors The list that collect errors
      * @param schemaObject The schemaObject to register
      * @throws LdapException If there is a problem
      */
@@ -1888,6 +1915,8 @@ public class Registries implements Schem
 
     /**
      * Dump the UsedBy data structure as a String
+     * 
+     * @return The UsedBy data structure
      */
     public String dumpUsedBy()
     {
@@ -1934,6 +1963,8 @@ public class Registries implements Schem
 
     /**
      * Dump the Using data structure as a String
+     * 
+     * @return The Using data structure
      */
     public String dumpUsing()
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaLoader.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaLoader.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaLoader.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaLoader.java Thu Sep  1 14:43:01 2016
@@ -49,7 +49,9 @@ public interface SchemaLoader
      * a list of specified schema
      *
      * @param schemas the schemas from which AttributeTypes are loaded
+     * @return The list of loaded AttributeTypes
      * @throws LdapException if there are failures accessing AttributeType information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadAttributeTypes( Schema... schemas ) throws LdapException, IOException;
 
@@ -59,7 +61,9 @@ public interface SchemaLoader
      * a list of specific schema, using their name
      *
      * @param schemaNames the schema names from which AttributeTypes are loaded
+     * @return The list of loaded AttributeTypes
      * @throws LdapException if there are failures accessing AttributeType information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadAttributeTypes( String... schemaNames ) throws LdapException, IOException;
 
@@ -69,7 +73,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which Comparators are loaded
+     * @return The list of loaded Comparators
      * @throws LdapException if there are failures accessing Comparator information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadComparators( Schema... schemas ) throws LdapException, IOException;
 
@@ -79,7 +85,9 @@ public interface SchemaLoader
      * a list of specific schema, using their name
      *
      * @param schemaNames the schema names from which Comparators are loaded
+     * @return The list of loaded Comparators
      * @throws LdapException if there are failures accessing Comparator information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadComparators( String... schemaNames ) throws LdapException, IOException;
 
@@ -89,7 +97,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which DitContentRules are loaded
+     * @return The list of loaded DitContentRules
      * @throws LdapException if there are failures accessing DitContentRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadDitContentRules( Schema... schemas ) throws LdapException, IOException;
 
@@ -99,7 +109,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which DitContentRules are loaded
+     * @return The list of loaded DitContentRules
      * @throws LdapException if there are failures accessing DitContentRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadDitContentRules( String... schemaNames ) throws LdapException, IOException;
 
@@ -109,7 +121,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which DitStructureRules are loaded
+     * @return The list of loaded DitStructureRules
      * @throws LdapException if there are failures accessing DitStructureRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadDitStructureRules( Schema... schemas ) throws LdapException, IOException;
 
@@ -119,7 +133,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which DitStructureRules are loaded
+     * @return The list of loaded DitStructureRules
      * @throws LdapException if there are failures accessing DitStructureRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadDitStructureRules( String... schemaNames ) throws LdapException, IOException;
 
@@ -129,7 +145,9 @@ public interface SchemaLoader
      * a list of specific schema
      *
      * @param schemas the schemas from which MatchingRules are loaded
+     * @return The list of loaded MatchingRules
      * @throws LdapException if there are failures accessing MatchingRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadMatchingRules( Schema... schemas ) throws LdapException, IOException;
 
@@ -139,7 +157,9 @@ public interface SchemaLoader
      * a list of specific schema, using their name
      *
      * @param schemaNames the schema names from which MatchingRules are loaded
+     * @return The list of loaded MatchingRules
      * @throws LdapException if there are failures accessing MatchingRule information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadMatchingRules( String... schemaNames ) throws LdapException, IOException;
 
@@ -149,7 +169,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which MatchingRuleUses are loaded
+     * @return The list of loaded MatchingRuleUses
      * @throws LdapException if there are failures accessing MatchingRuleUse information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadMatchingRuleUses( Schema... schemas ) throws LdapException, IOException;
 
@@ -159,7 +181,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which MatchingRuleUses are loaded
+     * @return The list of loaded MatchingRuleUses
      * @throws LdapException if there are failures accessing MatchingRuleUses information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadMatchingRuleUses( String... schemaNames ) throws LdapException, IOException;
 
@@ -169,7 +193,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which NameForms are loaded
+     * @return The list of loaded NameForms
      * @throws LdapException if there are failures accessing NameForm information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadNameForms( Schema... schemas ) throws LdapException, IOException;
 
@@ -179,7 +205,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which NameForms are loaded
+     * @return The list of loaded NameForms
      * @throws LdapException if there are failures accessing NameForms information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadNameForms( String... schemaNames ) throws LdapException, IOException;
 
@@ -189,7 +217,9 @@ public interface SchemaLoader
      * a list of specified schema
      *
      * @param schemas the schemas from which Normalizers are loaded
+     * @return The list of loaded Normalizers
      * @throws LdapException if there are failures accessing Normalizer information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadNormalizers( Schema... schemas ) throws LdapException, IOException;
 
@@ -199,7 +229,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which Normalizers are loaded
+     * @return The list of loaded Normalizers
      * @throws LdapException if there are failures accessing Normalizer information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadNormalizers( String... schemaNames ) throws LdapException, IOException;
 
@@ -209,7 +241,9 @@ public interface SchemaLoader
      * a list of specific schema.
      *
      * @param schemas the schemas from which ObjectClasses are loaded
+     * @return The list of loaded ObjectClasses
      * @throws LdapException if there are failures accessing ObjectClass information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadObjectClasses( Schema... schemas ) throws LdapException, IOException;
 
@@ -219,7 +253,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which ObjectClasses are loaded
+     * @return The list of loaded ObjectClasses
      * @throws LdapException if there are failures accessing ObjectClasses information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadObjectClasses( String... schemaNames ) throws LdapException, IOException;
 
@@ -229,7 +265,9 @@ public interface SchemaLoader
      * a list of specified schema
      *
      * @param schemas the schemas from which Syntaxes are loaded
+     * @return The list of loaded Syntaxes
      * @throws LdapException if there are failures accessing Syntax information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadSyntaxes( Schema... schemas ) throws LdapException, IOException;
 
@@ -239,7 +277,9 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which Syntaxes are loaded
+     * @return The list of loaded Syntaxes
      * @throws LdapException if there are failures accessing Syntax information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadSyntaxes( String... schemaNames ) throws LdapException, IOException;
 
@@ -249,7 +289,9 @@ public interface SchemaLoader
      * a list of specified schema
      *
      * @param schemas the schemas from which SyntaxCheckers are loaded
+     * @return The list of loaded SyntaxeCheckers
      * @throws LdapException if there are failures accessing SyntaxChecker information
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadSyntaxCheckers( Schema... schemas ) throws LdapException, IOException;
 
@@ -259,7 +301,10 @@ public interface SchemaLoader
      * a list of specified schema names
      *
      * @param schemaNames the schema names from which SyntaxCheckers are loaded
+     * @return A list of loaded SyntaxCheckers
      * @throws LdapException if there are failures accessing SyntaxChecker information
+     * @throws IOException If we had some issues loading the schemas
+     * @throws IOException If we can't read the schemaObject
      */
     List<Entry> loadSyntaxCheckers( String... schemaNames ) throws LdapException, IOException;
 
@@ -278,6 +323,8 @@ public interface SchemaLoader
 
     /**
      * Add a new schema to the schema's list
+     * 
+     * @param schema The schema to add
      */
     void addSchema( Schema schema );
 

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaObjectRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaObjectRegistry.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaObjectRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/SchemaObjectRegistry.java Thu Sep  1 14:43:01 2016
@@ -29,7 +29,8 @@ import org.apache.directory.api.ldap.mod
 
 /**
  * Common schema object registry interface.
- *
+ * 
+ * @param <T> The SchemaObject type
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public interface SchemaObjectRegistry<T extends SchemaObject>
@@ -115,6 +116,7 @@ public interface SchemaObjectRegistry<T
      * numeric OID.
      * 
      * @param numericOid the numeric identifier
+     * @return The unregistred schema object
      * @throws LdapException if the numeric identifier is invalid
      */
     T unregister( String numericOid ) throws LdapException;
@@ -124,6 +126,7 @@ public interface SchemaObjectRegistry<T
      * Removes the SchemaObject registered with this registry.
      * 
      * @param schemaObject the schemaObject to unregister
+     * @return The unregistred schema object
      * @throws LdapException if the schemaObject can't be unregistered is invalid
      */
     T unregister( T schemaObject ) throws LdapException;
@@ -134,6 +137,7 @@ public interface SchemaObjectRegistry<T
      * this registry.
      * 
      * @param schemaName the name of the schema whose SchemaObjects will be removed from
+     * @throws LdapException If we had a problem while unregistering the schema
      */
     void unregisterSchemaElements( String schemaName ) throws LdapException;
 
@@ -156,7 +160,7 @@ public interface SchemaObjectRegistry<T
      * Copy a DefaultSchemaObjectRegistry. All the stored SchemaObject will also
      * be copied, by the cross references will be lost.
      * 
-     * @return SchemaObjectRegistry<T> The copied registry
+     * @return The copied registry
      */
     SchemaObjectRegistry<T> copy();
 
@@ -175,6 +179,8 @@ public interface SchemaObjectRegistry<T
 
     /**
      * Clear the registry from all its content
+     * 
+     * @throws LdapException If we had a failure while clearing the registry
      */
     void clear() throws LdapException;
     

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/AttributeTypeHelper.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/AttributeTypeHelper.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/AttributeTypeHelper.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/AttributeTypeHelper.java Thu Sep  1 14:43:01 2016
@@ -52,7 +52,6 @@ public final class AttributeTypeHelper
     {
     }
 
-    
     /**
      * Inject the AttributeType into the Registries, updating the references to
      * other SchemaObject
@@ -63,7 +62,7 @@ public final class AttributeTypeHelper
      * @param attributeType The AttributeType to add to the Registries
      * @param errors The errors we got while adding the AttributeType to the Registries
      * @param registries The Registries
-     * @exception If the AttributeType is not valid
+     * @throws LdapException If the AttributeType is not valid
      */
     public static void addToRegistries( MutableAttributeType attributeType, List<Throwable> errors, Registries registries ) throws LdapException
     {
@@ -626,7 +625,7 @@ public final class AttributeTypeHelper
      * @param attributeType The AttributeType to remove from the Registries
      * @param errors The errors we got while removing the AttributeType from the Registries
      * @param registries The Registries
-     * @exception If the AttributeType is not valid
+     * @throws LdapException If the AttributeType is not valid
      */
     public static void removeFromRegistries( AttributeType attributeType, List<Throwable> errors, Registries registries ) throws LdapException
     {

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitContentRuleHelper.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitContentRuleHelper.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitContentRuleHelper.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitContentRuleHelper.java Thu Sep  1 14:43:01 2016
@@ -49,7 +49,7 @@ public final class DitContentRuleHelper
      * @param ditContentRule The DitContentRule to add to the Registries
      * @param errors The errors we got while adding the DitContentRule to the Registries
      * @param registries The Registries
-     * @exception If the addition failed
+     * @throws LdapException If the addition failed
      */
     public static void addToRegistries( DitContentRule ditContentRule, List<Throwable> errors, Registries registries )
         throws LdapException

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java Thu Sep  1 14:43:01 2016
@@ -47,7 +47,7 @@ public final class DitStructureRuleHelpe
      * @param ditStructureRule The DitStructureRule to add to the Registries
      * @param errors The errors we got while adding the DitContentRule to the Registries
      * @param registries The Registries
-     * @exception If the addition failed
+     * @throws LdapException If the addition failed
      */
     public static void addToRegistries( DitStructureRule ditStructureRule, List<Throwable> errors, Registries registries )
         throws LdapException

Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java?rev=1758787&r1=1758786&r2=1758787&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java Thu Sep  1 14:43:01 2016
@@ -49,7 +49,7 @@ public final class LdapSyntaxHelper
      * @param ldapSyntax The LdapSyntax to add to the Registries
      * @param errors The errors we got while adding the LdapSyntax to the Registries
      * @param registries The Registries
-     * @exception If the addition failed
+     * @throws LdapException If the addition failed
      */
     public static void addToRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries )
         throws LdapException
@@ -99,7 +99,7 @@ public final class LdapSyntaxHelper
      * @param ldapSyntax The LdapSyntax to remove from the Registries
      * @param errors The errors we got while removing the LdapSyntax from the Registries
      * @param registries The Registries
-     * @exception If the LdapSyntax is not valid
+     * @throws LdapException If the LdapSyntax is not valid
      */
     public static void removeFromRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries )
         throws LdapException




Mime
View raw message