From 6870993d12bf8a2b9d5cd103dc5ccabc42f9bf5d Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Wed, 15 Oct 2014 15:17:11 +0000
Subject: [PATCH] AutoRefactored comments/javadocs on OpenDJ SDK

---
 opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java |   58 +++++++++++++++++++---------------------------------------
 1 files changed, 19 insertions(+), 39 deletions(-)

diff --git a/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java b/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
index 07c00ea..62acf30 100644
--- a/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
+++ b/opendj-config/src/main/java/org/forgerock/opendj/config/client/ldap/LDAPDriver.java
@@ -105,14 +105,12 @@
             return pd.castValue(pd.accept(new ValueDecoder(), s));
         }
 
-        // Prevent instantiation.
+        /** Prevent instantiation. */
         private ValueDecoder() {
             // Do nothing.
         }
 
-        /**
-         * {@inheritDoc}
-         */
+        /** {@inheritDoc} */
         @Override
         public <C extends ConfigurationClient, S extends Configuration> Object visitAggregation(
             AggregationPropertyDefinition<C, S> d, String p) {
@@ -126,9 +124,7 @@
             }
         }
 
-        /**
-         * {@inheritDoc}
-         */
+        /** {@inheritDoc} */
         @Override
         public <T> Object visitUnknown(PropertyDefinition<T> d, String p) {
             // By default the property definition's decoder will do.
@@ -140,8 +136,10 @@
 
     private final Connection connection;
 
-    // The LDAP profile which should be used to construct LDAP
-    // requests and decode LDAP responses.
+    /**
+     * The LDAP profile which should be used to construct LDAP
+     * requests and decode LDAP responses.
+     */
     private final LDAPProfile profile;
 
     /**
@@ -162,17 +160,13 @@
         this.context = context;
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public void close() {
         connection.close();
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public <C extends ConfigurationClient, S extends Configuration> ManagedObject<? extends C> getManagedObject(
         ManagedObjectPath<C, S> path) throws DefinitionDecodingException, ManagedObjectDecodingException,
@@ -224,9 +218,7 @@
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @SuppressWarnings("unchecked")
     @Override
     public <C extends ConfigurationClient, S extends Configuration, P> SortedSet<P> getPropertyValues(
@@ -291,18 +283,14 @@
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public ManagedObject<RootCfgClient> getRootConfigurationManagedObject() {
         return new LDAPManagedObject<RootCfgClient>(this, RootCfgDefn.getInstance(), ManagedObjectPath.emptyPath(),
             new PropertySet(), true, null);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public <C extends ConfigurationClient, S extends Configuration> String[] listManagedObjects(
         ManagedObjectPath<?, ?> parent, InstantiableRelationDefinition<C, S> rd,
@@ -337,9 +325,7 @@
         return children.toArray(new String[children.size()]);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public <C extends ConfigurationClient, S extends Configuration> String[] listManagedObjects(
         ManagedObjectPath<?, ?> parent, SetRelationDefinition<C, S> rd,
@@ -375,9 +361,7 @@
         return children.toArray(new String[children.size()]);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public boolean managedObjectExists(ManagedObjectPath<?, ?> path) throws ManagedObjectNotFoundException,
         LdapException {
@@ -395,9 +379,7 @@
         return entryExists(dn);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     protected <C extends ConfigurationClient, S extends Configuration> void deleteManagedObject(
         ManagedObjectPath<C, S> path) throws OperationRejectedException, LdapException {
@@ -415,9 +397,7 @@
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     protected LDAPManagementContext getManagementContext() {
         return context;
@@ -461,7 +441,7 @@
         return profile;
     }
 
-    // Create a managed object which already exists on the server.
+    /** Create a managed object which already exists on the server. */
     private <M extends ConfigurationClient, N extends Configuration> ManagedObject<M> createExistingManagedObject(
         ManagedObjectDefinition<M, N> d, ManagedObjectPath<? super M, ? super N> p, PropertySet properties) {
         RelationDefinition<?, ?> rd = p.getRelationDefinition();
@@ -473,7 +453,7 @@
         return new LDAPManagedObject<M>(this, d, p.asSubType(d), properties, true, pd);
     }
 
-    // Create a property using the provided string values.
+    /** Create a property using the provided string values. */
     private <P> void decodeProperty(PropertySet newProperties, ManagedObjectPath<?, ?> path,
         PropertyDefinition<P> propertyDef, Attribute attribute) {
         PropertyException exception = null;
@@ -556,7 +536,7 @@
         return d.resolveManagedObjectDefinition(resolver);
     }
 
-    /*
+    /**
      * Delete a subtree of entries. We cannot use the subtree delete control because it is not supported by the config
      * backend.
      */

--
Gitblit v1.10.0