You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2009/11/11 08:05:28 UTC

svn commit: r834785 - in /directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema: DefaultSchemaManager.java loader/ldif/SchemaEntityFactory.java

Author: elecharny
Date: Wed Nov 11 07:05:28 2009
New Revision: 834785

URL: http://svn.apache.org/viewvc?rev=834785&view=rev
Log:
o Added some Javadoc
o Move the SchemaManager parameter in all the methods to be at the first position

Modified:
    directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/DefaultSchemaManager.java
    directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/loader/ldif/SchemaEntityFactory.java

Modified: directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/DefaultSchemaManager.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/DefaultSchemaManager.java?rev=834785&r1=834784&r2=834785&view=diff
==============================================================================
--- directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/DefaultSchemaManager.java (original)
+++ directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/DefaultSchemaManager.java Wed Nov 11 07:05:28 2009
@@ -545,7 +545,7 @@
     private AttributeType registerAttributeType( Registries registries, Entry entry, Schema schema ) 
         throws Exception
     {
-        AttributeType attributeType = factory.getAttributeType( entry, registries, this, schema.getSchemaName() );
+        AttributeType attributeType = factory.getAttributeType( this, entry, registries, schema.getSchemaName() );
         
         if ( registries.isRelaxed() )
         {
@@ -675,7 +675,7 @@
         throws Exception
     {
         MatchingRule matchingRule = factory.getMatchingRule( 
-            entry, registries, schema.getSchemaName() );
+            this, entry, registries, schema.getSchemaName() );
 
         if ( registries.isRelaxed() )
         {
@@ -804,7 +804,7 @@
     private ObjectClass registerObjectClass( Registries registries, Entry entry, Schema schema) 
         throws Exception
     {
-        ObjectClass objectClass = factory.getObjectClass( entry, registries, schema.getSchemaName() );
+        ObjectClass objectClass = factory.getObjectClass( this, entry, registries, schema.getSchemaName() );
 
         if ( registries.isRelaxed() )
         {
@@ -900,7 +900,7 @@
     private LdapSyntax registerSyntax( Registries registries, Entry entry, Schema schema) 
         throws Exception
     {
-        LdapSyntax syntax = factory.getSyntax( 
+        LdapSyntax syntax = factory.getSyntax( this,
             entry, registries, schema.getSchemaName() );
 
         if ( registries.isRelaxed() )

Modified: directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/loader/ldif/SchemaEntityFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/loader/ldif/SchemaEntityFactory.java?rev=834785&r1=834784&r2=834785&view=diff
==============================================================================
--- directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/loader/ldif/SchemaEntityFactory.java (original)
+++ directory/shared/branches/shared-schema/ldap-schema-loader/src/main/java/org/apache/directory/shared/schema/loader/ldif/SchemaEntityFactory.java Wed Nov 11 07:05:28 2009
@@ -204,6 +204,9 @@
     }
 
     
+    /**
+     * {@inheritDoc}
+     */
     public Schema getSchema( Entry entry ) throws Exception
     {
         String name;
@@ -251,7 +254,7 @@
             dependencies = depsSet.toArray( EMPTY_ARRAY );
         }
         
-        return new DefaultSchema( name, owner, dependencies, isDisabled ){};
+        return new DefaultSchema( name, owner, dependencies, isDisabled );
     }
     
     
@@ -295,11 +298,7 @@
     
     
     /**
-     * Retrieve and load a syntaxChecker class from the DIT.
-     * 
-     * @param entry the entry to load the syntaxChecker from
-     * @return the loaded SyntaxChecker
-     * @throws NamingException if anything fails during loading
+     * {@inheritDoc}
      */
     public SyntaxChecker getSyntaxChecker( SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName ) throws Exception
     {
@@ -338,13 +337,7 @@
     
     
     /**
-     * Create a new instance of a SyntaxChecker 
-     *
-     * @param syntaxCheckerDescription
-     * @param targetRegistries
-     * @param schemaName
-     * @return A new instance of a syntaxChecker
-     * @throws Exception If the creation has failed
+     * {@inheritDoc}
      */
     public SyntaxChecker getSyntaxChecker( SchemaManager schemaManager, SyntaxCheckerDescription syntaxCheckerDescription, 
         Registries targetRegistries, String schemaName ) throws Exception
@@ -423,13 +416,7 @@
     
     
     /**
-     * Create a new instance of a LdapComparator 
-     *
-     * @param comparatorDescription
-     * @param targetRegistries
-     * @param schemaName
-     * @return A new instance of a LdapComparator
-     * @throws Exception If the creation has failed
+     * {@inheritDoc}
      */
     public LdapComparator<?> getLdapComparator( SchemaManager schemaManager, 
         LdapComparatorDescription comparatorDescription, 
@@ -470,16 +457,10 @@
     
     
     /**
-     * Retrieve and load a Comparator class from the DIT.
-     * 
-     * @param entry the entry to load the Comparator from
-     * @param targetRegistries The registries
-     * @param schemaName The schema this SchemaObject will be part of
-     * @return the loaded Comparator
-     * @throws NamingException if anything fails during loading
+     * {@inheritDoc}
      */
-    public LdapComparator<?> getLdapComparator( SchemaManager schemaManager, Entry entry, 
-        Registries targetRegistries, String schemaName ) throws Exception
+    public LdapComparator<?> getLdapComparator( SchemaManager schemaManager, 
+        Entry entry, Registries targetRegistries, String schemaName ) throws Exception
     {
         checkEntry( entry, SchemaConstants.COMPARATOR );
         
@@ -555,15 +536,10 @@
 
     
     /**
-     * Create a new instance of a Normalizer 
-     *
-     * @param normalizerDescription
-     * @param targetRegistries
-     * @param schemaName
-     * @return A new instance of a normalizer
-     * @throws Exception If the creation has failed
+     * {@inheritDoc}
      */
-    public Normalizer getNormalizer( SchemaManager schemaManager, NormalizerDescription normalizerDescription, 
+    public Normalizer getNormalizer( SchemaManager schemaManager, 
+        NormalizerDescription normalizerDescription, 
         Registries targetRegistries, String schemaName ) throws Exception
     {
         checkDescription( normalizerDescription, SchemaConstants.NORMALIZER );
@@ -600,13 +576,10 @@
     
     
     /**
-     * Retrieve and load a Normalizer class from the DIT.
-     * 
-     * @param entry the entry to load the Normalizer from
-     * @return the loaded Normalizer
-     * @throws NamingException if anything fails during loading
+     * {@inheritDoc}
      */
-    public Normalizer getNormalizer( SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName ) 
+    public Normalizer getNormalizer( SchemaManager schemaManager, Entry entry, 
+        Registries targetRegistries, String schemaName ) 
         throws Exception
     {
         checkEntry( entry, SchemaConstants.NORMALIZER );
@@ -678,7 +651,10 @@
     }
 
 
-    public LdapSyntax getSyntax( Entry entry, Registries targetRegistries, String schemaName ) throws NamingException
+    /**
+     * {@inheritDoc}
+     */
+    public LdapSyntax getSyntax( SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName ) throws NamingException
     {
         checkEntry( entry, SchemaConstants.SYNTAX );
 
@@ -717,15 +693,10 @@
 
     
     /**
-     * Construct an MatchingRule from an entry get from the Dit
-     *
-     * @param entry The entry containing all the informations to build a MatchingRule
-     * @param targetRegistries The registries containing all the enabled SchemaObjects
-     * @param schemaName The schema containing this MatchingRule
-     * @return A MatchingRule SchemaObject
-     * @throws NamingException If the MatchingRule is invalid
+     * {@inheritDoc}
      */
-    public MatchingRule getMatchingRule( Entry entry, Registries targetRegistries, String schemaName ) throws NamingException
+    public MatchingRule getMatchingRule( SchemaManager schemaManager, Entry entry, 
+        Registries targetRegistries, String schemaName ) throws NamingException
     {
         checkEntry( entry, SchemaConstants.MATCHING_RULE );
 
@@ -785,7 +756,11 @@
     }
     
     
-    public ObjectClass getObjectClass( Entry entry, Registries targetRegistries, String schemaName ) throws Exception
+    /**
+     * {@inheritDoc}
+     */
+    public ObjectClass getObjectClass( SchemaManager schemaManager, Entry entry, 
+        Registries targetRegistries, String schemaName ) throws Exception
     {
         checkEntry( entry, SchemaConstants.OBJECT_CLASS );
 
@@ -848,16 +823,10 @@
     
     
     /**
-     * Construct an AttributeType from an entry representing an AttributeType.
-     *
-     * @param entry The entry containing all the informations to build an AttributeType
-     * @param targetRegistries The registries containing all the enabled SchemaObjects
-     * @param schemaManager The schema Manager
-     * @param schemaName The schema containing this AttributeType
-     * @return An AttributeType SchemaObject
-     * @throws NamingException If the AttributeType is invalid
+     * {@inheritDoc}
      */
-    public AttributeType getAttributeType( Entry entry, Registries targetRegistries, SchemaManager schemaManager, String schemaName ) throws NamingException
+    public AttributeType getAttributeType( SchemaManager schemaManager, Entry entry, 
+        Registries targetRegistries, String schemaName ) throws NamingException
     {
         checkEntry( entry, SchemaConstants.ATTRIBUTE_TYPE );