directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758737 - in /directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema: loader/ manager/impl/
Date Thu, 01 Sep 2016 08:54:56 GMT
Author: elecharny
Date: Thu Sep  1 08:54:55 2016
New Revision: 1758737

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

Modified:
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/JarLdifSchemaLoader.java
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/LdifSchemaLoader.java
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SchemaEntityFactory.java
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SingleLdifSchemaLoader.java
    directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
Thu Sep  1 08:54:55 2016
@@ -140,8 +140,8 @@ public interface EntityFactory
      * @param entry The entry containing all the informations to build an ObjectClass
      * @param targetRegistries The registries containing all the enabled SchemaObjects
      * @param schemaName The schema this SchemaObject will be part of
-     * @return
-     * @throws LdapException
+     * @return The loaded ObjectClass
+     * @throws LdapException if anything fails during loading
      */
     ObjectClass getObjectClass( SchemaManager schemaManager, Entry entry, Registries targetRegistries,
String schemaName )
         throws LdapException;
@@ -153,8 +153,8 @@ public interface EntityFactory
      * @param entry The entry containing all the informations to build a LdapSyntax
      * @param targetRegistries The registries containing all the enabled SchemaObjects
      * @param schemaName The schema this SchemaObject will be part of
-     * @return
-     * @throws LdapException
+     * @return The loaded Syntax
+     * @throws LdapException if anything fails during loading
      */
     LdapSyntax getSyntax( SchemaManager schemaManager, Entry entry, Registries targetRegistries,
String schemaName )
         throws LdapException;

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/JarLdifSchemaLoader.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/JarLdifSchemaLoader.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/JarLdifSchemaLoader.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/JarLdifSchemaLoader.java
Thu Sep  1 08:54:55 2016
@@ -81,6 +81,7 @@ public class JarLdifSchemaLoader extends
      *
      * @throws LdapException if the base directory does not exist or does not
      * a valid schema.ldif file
+     * @throws IOException If we can't load the schema
      */
     public JarLdifSchemaLoader() throws IOException, LdapException
     {

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/LdifSchemaLoader.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/LdifSchemaLoader.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/LdifSchemaLoader.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/LdifSchemaLoader.java
Thu Sep  1 08:54:55 2016
@@ -83,6 +83,7 @@ public class LdifSchemaLoader extends Ab
      * @param baseDirectory the schema LDIF base directory
      * @throws LdapException if the base directory does not exist or does not
      * a valid schema.ldif file
+     * @throws IOException If we can't load the schema
      */
     public LdifSchemaLoader( File baseDirectory ) throws LdapException, IOException
     {

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SchemaEntityFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SchemaEntityFactory.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SchemaEntityFactory.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SchemaEntityFactory.java
Thu Sep  1 08:54:55 2016
@@ -803,8 +803,8 @@ public class SchemaEntityFactory impleme
 
     /**
      * {@inheritDoc}
-     * @throws LdapInvalidAttributeValueException
-     * @throws LdapUnwillingToPerformException
+     * @throws LdapInvalidAttributeValueException If the Syntax does not exist
+     * @throws LdapUnwillingToPerformException If the schema is not loaded
      */
     public LdapSyntax getSyntax( SchemaManager schemaManager, Entry entry, Registries targetRegistries,
         String schemaName ) throws LdapInvalidAttributeValueException, LdapUnwillingToPerformException
@@ -845,8 +845,8 @@ public class SchemaEntityFactory impleme
 
     /**
      * {@inheritDoc}
-     * @throws LdapUnwillingToPerformException
-     * @throws LdapInvalidAttributeValueException
+     * @throws LdapInvalidAttributeValueException If the MatchingRule does not exist
+     * @throws LdapUnwillingToPerformException If the schema is not loaded
      */
     public MatchingRule getMatchingRule( SchemaManager schemaManager, Entry entry, Registries
targetRegistries,
         String schemaName ) throws LdapUnwillingToPerformException, LdapInvalidAttributeValueException
@@ -991,8 +991,8 @@ public class SchemaEntityFactory impleme
 
     /**
      * {@inheritDoc}
-     * @throws LdapInvalidAttributeValueException
-     * @throws LdapUnwillingToPerformException
+     * @throws LdapInvalidAttributeValueException If the AttributeType does not exist
+     * @throws LdapUnwillingToPerformException If the schema is not loaded
      */
     public AttributeType getAttributeType( SchemaManager schemaManager, Entry entry, Registries
targetRegistries,
         String schemaName ) throws LdapInvalidAttributeValueException, LdapUnwillingToPerformException

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SingleLdifSchemaLoader.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SingleLdifSchemaLoader.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SingleLdifSchemaLoader.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/SingleLdifSchemaLoader.java
Thu Sep  1 08:54:55 2016
@@ -102,6 +102,8 @@ public class SingleLdifSchemaLoader exte
     
     /**
      * Instantiates a new single LDIF schema loader.
+     * 
+     * @param schemaFile The Schema to load
      */
     public SingleLdifSchemaLoader( String schemaFile )
     {
@@ -129,6 +131,8 @@ public class SingleLdifSchemaLoader exte
     
     /**
      * Instantiates a new single LDIF schema loader.
+     * 
+     * @param schemaUrl The URL of the schema to load
      */
     public SingleLdifSchemaLoader( URL schemaUrl )
     {

Modified: directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java?rev=1758737&r1=1758736&r2=1758737&view=diff
==============================================================================
--- directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
(original)
+++ directory/shared/trunk/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
Thu Sep  1 08:54:55 2016
@@ -1582,7 +1582,7 @@ public class DefaultSchemaManager implem
     /**
      * Initializes the SchemaService
      *
-     * @throws Exception If the initialization fails
+     * @throws LdapException If the initialization fails
      */
     public void initialize() throws LdapException
     {



Mime
View raw message