directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758954 [1/2] - in /directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec: ./ actions/ldapMessage/ api/ controls/cascade/ controls/manageDsaIT/ controls/proxiedauthz/ controls/search/entry...
Date Fri, 02 Sep 2016 13:37:21 GMT
Author: elecharny
Date: Fri Sep  2 13:37:20 2016
New Revision: 1758954

URL: http://svn.apache.org/viewvc?rev=1758954&view=rev
Log:
Fixed the Javadoc

Modified:
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/BasicControlDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/InitLdapMessage.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/StoreMessageId.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/DefaultConfigurableBinaryAttributeDetector.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiServiceFactory.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapDecoder.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/cascade/CascadeDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/manageDsaIT/ManageDsaITDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/proxiedauthz/ProxiedAuthzDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsFactory.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesFactory.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableResultResponseRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/IntermediateResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/LdapResultDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/RequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResponseDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResultResponseRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultDoneDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultReferenceDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SingleReplyRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/UnbindRequestDecorator.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AndFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AttributeValueAssertionFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ConnectorFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ExtensibleMatchFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/NotFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/OrFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/PresentFilter.java
    directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java Fri Sep  2 13:37:20 2016
@@ -41,9 +41,6 @@ import org.apache.directory.api.util.Str
  */
 public class AttributeValueAssertion
 {
-    // ~ Instance fields
-    // ----------------------------------------------------------------------------
-
     /** The attribute description */
     private String attributeDesc;
 
@@ -52,9 +49,9 @@ public class AttributeValueAssertion
 
 
     /**
-     *
      * Helper method to render an object which can be a String or a byte[]
      *
+     * @param object the Object to render
      * @return A string representing the object
      */
     public static String dumpObject( Object object )

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/BasicControlDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/BasicControlDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/BasicControlDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/BasicControlDecorator.java Fri Sep  2 13:37:20 2016
@@ -33,8 +33,8 @@ import org.apache.directory.api.ldap.mod
 
 /**
  * A decorator for handling opaque Control objects where we know nothing about 
- * their encoded value. These Controls are generated by default when an 
- * {@link ControlFactory} for them has not been registered with the 
+ * their encoded value. These Controls are generated by default when a 
+ * ControlFactory for them has not been registered with the 
  * {@link LdapApiService}.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/InitLdapMessage.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/InitLdapMessage.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/InitLdapMessage.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/InitLdapMessage.java Fri Sep  2 13:37:20 2016
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used to initialize an LdapMessage
  * <pre>
- * LDAPMessage --> SEQUENCE { ...
+ * LDAPMessage --&gt; SEQUENCE { ...
  *
  * We have a LDAPMessage, and the tag must be 0x30.
  *

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/StoreMessageId.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/StoreMessageId.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/StoreMessageId.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/ldapMessage/StoreMessageId.java Fri Sep  2 13:37:20 2016
@@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used to store the LdapMessage MessageID.
  * <pre>
- * LDAPMessage --> ... MessageId ...
+ * LDAPMessage --&gt; ... MessageId ...
  *
  * Checks that MessageId is in [0 .. 2147483647] and store the value in
  * the LdapMessage Object

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlDecorator.java Fri Sep  2 13:37:20 2016
@@ -30,7 +30,7 @@ import org.apache.directory.api.ldap.mod
  * decorator while processing.
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
- * @param <E>
+ * @param <E> The control type
  */
 public abstract class ControlDecorator<E extends Control> implements CodecControl<E>, Asn1Object
 {
@@ -50,6 +50,7 @@ public abstract class ControlDecorator<E
     /**
      * Creates a ControlDecorator to codec enable it.
      *
+     * @param codec The Ldap service to use
      * @param decoratedControl The Control to decorate.
      */
     public ControlDecorator( LdapApiService codec, E decoratedControl )

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java Fri Sep  2 13:37:20 2016
@@ -29,7 +29,7 @@ import org.apache.directory.api.ldap.mod
  * then registered with the codec and used by the codec to encode and decode
  * those controls.
  *
- * @TODO must review this interface - too many methods - implementors should not
+ * TODO must review this interface - too many methods - implementors should not
  * have to implement so many methods.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/DefaultConfigurableBinaryAttributeDetector.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/DefaultConfigurableBinaryAttributeDetector.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/DefaultConfigurableBinaryAttributeDetector.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/DefaultConfigurableBinaryAttributeDetector.java Fri Sep  2 13:37:20 2016
@@ -28,9 +28,9 @@ import org.apache.mina.util.ConcurrentHa
 
 /**
  * An implementation of the BinaryAttributeDetector interface. It's used
- * on the client side to detect if an Attribute is HumanRedable.<br/>
+ * on the client side to detect if an Attribute is HumanRedable.<br>
  * One can inject some new attributes, replace the existing list,
- * remove some attributes. <br/>
+ * remove some attributes. <br>
  * We provide a list of Attributes which are known to be binary :
  * <ul>
  * <li>entryACI</li>
@@ -56,7 +56,7 @@ import org.apache.mina.util.ConcurrentHa
  * <li>jpegPhoto</li>
  * <li>supportedAlgorithms</li>
  * </ul>
- * <br/>
+ * <br>
  * In order to reset the detector to get back to those default value, it's enough
  * to call the setBinaryAttributes() with null as a parameter.
  * 

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java Fri Sep  2 13:37:20 2016
@@ -66,6 +66,7 @@ public interface ExtendedOperationFactor
      * 
      * @param encodedValue The encoded value for the ExtendedResponse instance.
      * @return The new ExtendedResponse.
+     * @throws DecoderException If we can't decode the response
      */
     ExtendedResponse newResponse( byte[] encodedValue ) throws DecoderException;
 

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -53,6 +53,7 @@ public class ExtendedRequestDecorator<Q
     /**
      * Makes a ExtendedRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated ExtendedRequest
      */
     public ExtendedRequestDecorator( LdapApiService codec, Q decoratedMessage )
@@ -147,18 +148,19 @@ public class ExtendedRequestDecorator<Q
 
     /**
      * Compute the ExtendedRequest length
-     * 
+     * <br>
      * ExtendedRequest :
-     * 
+     * <pre>
      * 0x77 L1
      *  |
-     *  +--> 0x80 L2 name
-     *  [+--> 0x81 L3 value]
+     *  +--&gt; 0x80 L2 name
+     *  [+--&gt; 0x81 L3 value]
      * 
      * L1 = Length(0x80) + Length(L2) + L2
      *      [+ Length(0x81) + Length(L3) + L3]
      * 
      * Length(ExtendedRequest) = Length(0x77) + Length(L1) + L1
+     * </pre>
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -53,6 +53,7 @@ public class ExtendedResponseDecorator<R
     /**
      * Makes a ExtendedResponse encodable.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated ExtendedResponse
      */
     public ExtendedResponseDecorator( LdapApiService codec, R decoratedMessage )
@@ -106,20 +107,21 @@ public class ExtendedResponseDecorator<R
     //-------------------------------------------------------------------------
     /**
      * Compute the ExtendedResponse length
-     * 
+     * <br>
      * ExtendedResponse :
-     * 
+     * <pre>
      * 0x78 L1
      *  |
-     *  +--> LdapResult
-     * [+--> 0x8A L2 name
-     * [+--> 0x8B L3 response]]
+     *  +--&gt; LdapResult
+     * [+--&gt; 0x8A L2 name
+     * [+--&gt; 0x8B L3 response]]
      * 
      * L1 = Length(LdapResult)
      *      [ + Length(0x8A) + Length(L2) + L2
      *       [ + Length(0x8B) + Length(L3) + L3]]
      * 
      * Length(ExtendedResponse) = Length(0x78) + Length(L1) + L1
+     * </pre>
      * 
      * @return The ExtendedResponse length
      */
@@ -151,10 +153,13 @@ public class ExtendedResponseDecorator<R
 
     /**
      * Encode the ExtendedResponse message to a PDU. 
+     * <br>
      * ExtendedResponse :
+     * <pre>
      * LdapResult.encode()
      * [0x8A LL response name]
      * [0x8B LL response]
+     * </pre>
      * 
      * @param buffer The buffer where to put the PDU
      * @return The PDU.

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java Fri Sep  2 13:37:20 2016
@@ -32,7 +32,7 @@ import org.apache.mina.filter.codec.Prot
 
 
 /**
- * The service interface for the LDAP codec.
+ * The service interface for the LDAP codec. It gathers all the supported controls and extended operations.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -58,6 +58,7 @@ public interface LdapApiService
     /**
      * Checks if a control has been registered.
      * 
+     * @param oid The Control OID we are looking for
      * @return The OID of the control to check for registration
      */
     boolean isControlRegistered( String oid );
@@ -67,6 +68,7 @@ public interface LdapApiService
      * Registers an {@link ControlFactory} with this service.
      * 
      * @param factory The control factory
+     * @return The registred control factory
      */
     ControlFactory<?> registerControl( ControlFactory<?> factory );
 
@@ -75,6 +77,7 @@ public interface LdapApiService
      * Unregisters an {@link ControlFactory} with this service.
      * 
      * @param oid The oid of the control the factory is associated with.
+     * @return The unregistred control factory
      */
     ControlFactory<?> unregisterControl( String oid );
 
@@ -178,30 +181,30 @@ public interface LdapApiService
      * Creates a JNDI {@link javax.naming.ldap.ExtendedResponse} from the model 
      * {@link ExtendedResponse}.
      * 
-     * @param modelResponse
-     * @return
-     * @throws EncoderException
+     * @param modelResponse The extended response to convert
+     * @return A JNDI extended response
+     * @throws EncoderException If the conversion failed
      */
     javax.naming.ldap.ExtendedResponse toJndi( ExtendedResponse modelResponse ) throws EncoderException;
 
 
     /**
-     * Creates a model ExtendedResponse from the JNDI ExtendedResponse.
+     * Creates a model ExtendedResponse from the JNDI ExtendedRequest.
      *
-     * @param jndiResponse The JNDI ExtendedResponse 
-     * @return The model ExtendedResponse
-     * @throws DecoderException if the response value cannot be decoded.
+     * @param jndiRequest The JNDI ExtendedRequest 
+     * @return The model ExtendedRequest
+     * @throws DecoderException if the request value cannot be decoded.
      */
     ExtendedRequest fromJndi( javax.naming.ldap.ExtendedRequest jndiRequest ) throws DecoderException;
 
 
     /**
-     * Creates a JNDI {@link javax.naming.ldap.ExtendedResponse} from the model 
-     * {@link ExtendedResponse}.
+     * Creates a JNDI {@link javax.naming.ldap.ExtendedRequest} from the model 
+     * {@link ExtendedRequest}.
      * 
-     * @param modelResponse
-     * @return
-     * @throws EncoderException
+     * @param modelRequest The extended request to convert
+     * @return A JNDI extended request
+     * @throws EncoderException If the conversion failed
      */
     javax.naming.ldap.ExtendedRequest toJndi( ExtendedRequest modelRequest ) throws EncoderException;
 
@@ -231,7 +234,6 @@ public interface LdapApiService
     /**
      * Creates a new MessageContainer.
      *
-     * @TODO akarasulu - Wondering why is this not an LdapMessageContainer?
      * @return The newly created LDAP MessageContainer instance.
      */
     Asn1Container newMessageContainer();
@@ -244,6 +246,7 @@ public interface LdapApiService
      * @param responseName The extendedRespose OID
      * @param messageId The original message ID
      * @param serializedResponse The serialized response payload
+     * @param <E> The extended response type
      * @return The extendedResponse instance
      * 
      * @throws DecoderException If the payload is incorrect
@@ -262,8 +265,20 @@ public interface LdapApiService
     ExtendedRequest newExtendedRequest( String oid, byte[] value );
 
 
+    /**
+     * Decorates an extended request message, ie encapsulate it into a class that do the encoding/decoding
+     *
+     * @param decoratedMessage The extended request to decorate
+     * @return The decorated extended request
+     */
     ExtendedRequestDecorator<?> decorate( ExtendedRequest decoratedMessage );
 
 
+    /**
+     * Decorates an extended response message, ie encapsulate it into a class that do the encoding/decoding
+     *
+     * @param decoratedMessage The extended response to decorate
+     * @return The decorated extended response
+     */
     ExtendedResponseDecorator<?> decorate( ExtendedResponse decoratedMessage );
 }

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiServiceFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiServiceFactory.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiServiceFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiServiceFactory.java Fri Sep  2 13:37:20 2016
@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
  * A factory that allows callers a means to get a handle on an LdapCodecService
  * implementation regardless of the environment in which they're accessing it.
  * In an OSGi environment, the BundleActivator binds the LdapCodecService 
- * class member forever to the {@link DefaultLdapCodecService}. If in 
+ * class member forever to the DefaultLdapCodecService. If in 
  * 
  * In a standard standalone mode, the Bundle
  *

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapDecoder.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapDecoder.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapDecoder.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapDecoder.java Fri Sep  2 13:37:20 2016
@@ -69,7 +69,9 @@ public class LdapDecoder
      * decode one complete message.
      *
      * @param in The input stream to read and decode PDU bytes from
+     * @param container The LdapMessageContainer containing the message to decode
      * @return return The decoded message
+     * @throws DecoderException If the decoding failed
      */
     public Message decode( InputStream in, LdapMessageContainer<MessageDecorator<? extends Message>> container )
         throws DecoderException

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java Fri Sep  2 13:37:20 2016
@@ -141,9 +141,9 @@ public class LdapEncoder
      * <pre>
      * 0x30 L1 
      *   | 
-     *   +--> 0x02 L2 MessageId  
-     *   +--> ProtocolOp 
-     *   +--> Controls 
+     *   +--&gt; 0x02 L2 MessageId  
+     *   +--&gt; ProtocolOp 
+     *   +--&gt; Controls 
      *   
      * L2 = Length(MessageId)
      * L1 = Length(0x02) + Length(L2) + L2 + Length(ProtocolOp) + Length(Controls)
@@ -224,16 +224,18 @@ public class LdapEncoder
 
     /**
      * Compute the LdapMessage length LdapMessage : 
+     * <pre>
      * 0x30 L1 
      *   | 
-     *   +--> 0x02 0x0(1-4) [0..2^31-1] (MessageId) 
-     *   +--> protocolOp 
-     *   [+--> Controls] 
+     *   +--&gt; 0x02 0x0(1-4) [0..2^31-1] (MessageId) 
+     *   +--&gt; protocolOp 
+     *   [+--&gt; Controls] 
      *   
      * MessageId length = Length(0x02) + length(MessageId) + MessageId.length 
      * L1 = length(ProtocolOp) 
      * LdapMessage length = Length(0x30) + Length(L1) + MessageId length + L1
-     *
+     * </pre>
+     * 
      * @param messageDecorator the decorated Message who's length is to be encoded
      */
     private int computeMessageLength( MessageDecorator<? extends Message> messageDecorator )
@@ -304,7 +306,6 @@ public class LdapEncoder
      * 
      * @param buffer The buffer where to put the PDU
      * @param referral The referral to encode
-     * @return The encoded referral
      * @exception EncoderException If the encoding failed
      */
     public static void encodeReferral( ByteBuffer buffer, Referral referral ) throws EncoderException

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java Fri Sep  2 13:37:20 2016
@@ -55,6 +55,8 @@ public class LdapMessageContainer<E exte
     /**
      * Creates a new LdapMessageContainer object. We will store ten grammars,
      * it's enough ...
+     * 
+     * @param codec The LDAP service instance
      */
     public LdapMessageContainer( LdapApiService codec )
     {
@@ -66,6 +68,7 @@ public class LdapMessageContainer<E exte
      * Creates a new LdapMessageContainer object. We will store ten grammars,
      * it's enough ...
      *
+     * @param codec The LDAP service instance
      * @param binaryAttributeDetector checks if an attribute is binary
      */
     public LdapMessageContainer( LdapApiService codec, BinaryAttributeDetector binaryAttributeDetector )
@@ -81,7 +84,7 @@ public class LdapMessageContainer<E exte
     /**
      * Gets the {@link LdapApiService} associated with this Container.
      *
-     * @return
+     * @return The LDAP service instance
      */
     public LdapApiService getLdapCodecService()
     {
@@ -102,7 +105,7 @@ public class LdapMessageContainer<E exte
      * Set a Message Object into the container. It will be completed by the
      * ldapDecoder.
      *
-     * @param message The message to set.
+     * @param messageDecorator The message to set.
      */
     public void setMessage( E messageDecorator )
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageDecorator.java Fri Sep  2 13:37:20 2016
@@ -72,7 +72,7 @@ import org.apache.directory.api.ldap.mod
 /**
  * A decorator for the generic LDAP Message
  *
- * @TODO make this class abstract, after finishing switch and all types and make default blow an EncoderException
+ * TODO make this class abstract, after finishing switch and all types and make default blow an EncoderException
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public abstract class MessageDecorator<E extends Message> implements Message, Decorator<E>, Asn1Object
@@ -211,6 +211,9 @@ public abstract class MessageDecorator<E
 
     /**
      * Makes a Message an Decorator object.
+     * 
+     * @param codec The LDAP Service instance to use
+     * @param decoratedMessage The message to decorate
      */
     protected MessageDecorator( LdapApiService codec, E decoratedMessage )
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java Fri Sep  2 13:37:20 2016
@@ -75,6 +75,9 @@ public class ResponseCarryingException e
      * Creates a DecoderException
      * 
      * @param message A message with meaning to a human
+     * @param response The response to store
+     * @param code the ResultCode
+     * @param matchedDn The Matched DN
      * @param cause The Exception which caused the error
      */
     public ResponseCarryingException( String message, ResultResponse response, ResultCodeEnum code,

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/cascade/CascadeDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/cascade/CascadeDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/cascade/CascadeDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/cascade/CascadeDecorator.java Fri Sep  2 13:37:20 2016
@@ -40,6 +40,9 @@ public class CascadeDecorator extends Co
 {
     /**
      * Default constructor
+     * 
+     * @param codec The LDAP service instance
+     * @param control the Control to decorate
      */
     public CascadeDecorator( LdapApiService codec, Cascade control )
     {
@@ -48,7 +51,7 @@ public class CascadeDecorator extends Co
 
 
     /**
-     * Returns the default control length.
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/manageDsaIT/ManageDsaITDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/manageDsaIT/ManageDsaITDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/manageDsaIT/ManageDsaITDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/manageDsaIT/ManageDsaITDecorator.java Fri Sep  2 13:37:20 2016
@@ -40,6 +40,9 @@ public class ManageDsaITDecorator extend
 
     /**
      * Default constructor
+     * 
+     * @param codec The LDAP service instance
+     * @param control The ManageDsaIT to decorate
      */
     public ManageDsaITDecorator( LdapApiService codec, ManageDsaIT control )
     {
@@ -48,7 +51,7 @@ public class ManageDsaITDecorator extend
 
 
     /**
-     * Returns 0 every time.
+     * @return 0 every time.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/proxiedauthz/ProxiedAuthzDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/proxiedauthz/ProxiedAuthzDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/proxiedauthz/ProxiedAuthzDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/proxiedauthz/ProxiedAuthzDecorator.java Fri Sep  2 13:37:20 2016
@@ -50,6 +50,8 @@ public class ProxiedAuthzDecorator exten
     /**
      * Creates a new instance of ProxiedAuthzDecoder wrapping a newly created
      * ProxiedAuthz Control object.
+     * 
+     * @param codec The LDAP service instance
      */
     public ProxiedAuthzDecorator( LdapApiService codec )
     {
@@ -61,6 +63,7 @@ public class ProxiedAuthzDecorator exten
      * Creates a new instance of ProxiedAuthzDecorator wrapping the supplied
      * ProxiedAuthz Control.
      *
+     * @param codec The LDAP service instance
      * @param control The ProxiedAuthz Control to be decorated.
      */
     public ProxiedAuthzDecorator( LdapApiService codec, ProxiedAuthz control )
@@ -82,8 +85,11 @@ public class ProxiedAuthzDecorator exten
 
     /**
      * Compute the ProxiedAuthzControl length 
-     * 
-     *  0x04 L1 authzId] 
+     * <pre>
+     *  0x04 L1 authzId]
+     * </pre>
+     *  
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java Fri Sep  2 13:37:20 2016
@@ -40,6 +40,8 @@ public class EntryChangeContainer extend
     /**
      * Creates a new EntryChangeContainer object. We will store one
      * grammar, it's enough ...
+     * 
+     * @param codec The LDAP service instance
      */
     public EntryChangeContainer( LdapApiService codec )
     {
@@ -54,6 +56,7 @@ public class EntryChangeContainer extend
      * Creates a container with decorator, optionally decorating the supplied
      * Control if it is not a decorator implementation.
      *
+     * @param codec The LDAP service instance
      * @param control The EntryChange ControlDecorator, or a Control to be
      * wrapped by a new decorator.
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java Fri Sep  2 13:37:20 2016
@@ -64,6 +64,8 @@ public class EntryChangeDecorator extend
     /**
      * Creates a new instance of EntryChangeDecoder wrapping a newly created
      * EntryChange Control object.
+     * 
+     * @param codec The LDAP service instance
      */
     public EntryChangeDecorator( LdapApiService codec )
     {
@@ -75,6 +77,7 @@ public class EntryChangeDecorator extend
      * Creates a new instance of EntryChangeDecorator wrapping the supplied
      * EntryChange Control.
      *
+     * @param codec The LDAP service instance
      * @param control The EntryChange Control to be decorated.
      */
     public EntryChangeDecorator( LdapApiService codec, EntryChange control )
@@ -97,11 +100,15 @@ public class EntryChangeDecorator extend
     /**
      * Compute the EntryChangeControl length 
      * 
+     * <pre>
      * 0x30 L1 
      *   | 
-     *   +--> 0x0A 0x0(1-4) [1|2|4|8] (changeType) 
-     *  [+--> 0x04 L2 previousDN] 
-     *  [+--> 0x02 0x0(1-4) [0..2^63-1] (changeNumber)]
+     *   +--&gt; 0x0A 0x0(1-4) [1|2|4|8] (changeType) 
+     *  [+--&gt; 0x04 L2 previousDN] 
+     *  [+--&gt; 0x02 0x0(1-4) [0..2^63-1] (changeNumber)]
+     *  </pre>
+     *  
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsDecorator.java Fri Sep  2 13:37:20 2016
@@ -55,6 +55,8 @@ public class PagedResultsDecorator exten
     /**
      * Creates a new instance of PagedResultsDecorator with a newly created decorated
      * PagedResults Control.
+     * 
+     * @param codec The LDAP service instance
      */
     public PagedResultsDecorator( LdapApiService codec )
     {
@@ -66,6 +68,7 @@ public class PagedResultsDecorator exten
      * Creates a new instance of PagedResultsDecorator using the supplied PagedResults
      * Control to be decorated.
      *
+     * @param codec The LDAP service instance
      * @param  pagedResults The PagedResults Control to be decorated.
      */
     public PagedResultsDecorator( LdapApiService codec, PagedResults pagedResults )
@@ -83,9 +86,11 @@ public class PagedResultsDecorator exten
      * 
      * 0x30 L1 
      *   | 
-     *   +--> 0x02 0x0(1-4) [0..2^63-1] (size) 
-     *   +--> 0x04 L2 (cookie)
-     * </pre> 
+     *   +--&gt; 0x02 0x0(1-4) [0..2^63-1] (size) 
+     *   +--&gt; 0x04 L2 (cookie)
+     * </pre>
+     *  
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsFactory.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsFactory.java Fri Sep  2 13:37:20 2016
@@ -27,7 +27,7 @@ import org.apache.directory.api.ldap.mod
 
 
 /**
- * A {@link ControlFactory} for {@link EntryChange} controls.
+ * A {@link ControlFactory} for {@link PagedResults} controls.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java Fri Sep  2 13:37:20 2016
@@ -39,6 +39,8 @@ public class PersistentSearchContainer e
     /**
      * Creates a new PSearchControlContainer object. We will store one grammar,
      * it's enough ...
+     * 
+     * @param codec The LDAP service instance
      */
     public PersistentSearchContainer( LdapApiService codec )
     {
@@ -54,6 +56,7 @@ public class PersistentSearchContainer e
      * decorator wrapping the supplied control, or using the supplied control if
      * it already is a decorator.
      *
+     * @param codec The LDAP service instance
      * @param control The PersistentSearch Control or a decorating wrapper.
      */
     public PersistentSearchContainer( LdapApiService codec, PersistentSearch control )

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchDecorator.java Fri Sep  2 13:37:20 2016
@@ -54,6 +54,8 @@ public class PersistentSearchDecorator e
     /**
      * Default constructor creates a PersistentSearch Control automatically
      * wrapped in a decorator object inside this container.
+     * 
+     * @param codec The LDAP service instance
      */
     public PersistentSearchDecorator( LdapApiService codec )
     {
@@ -65,6 +67,7 @@ public class PersistentSearchDecorator e
      * Creates a PersistentSearch Control wrapping a supplied PersistentSearch
      * Control.
      *
+     * @param codec The LDAP service instance
      * @param control The PersistentSearch Control to wrap.
      */
     public PersistentSearchDecorator( LdapApiService codec, PersistentSearch control )
@@ -82,10 +85,12 @@ public class PersistentSearchDecorator e
      * 
      * 0x30 L1 
      *   | 
-     *   +--> 0x02 0x0(1-4) [0..2^31-1] (changeTypes) 
-     *   +--> 0x01 0x01 [0x00 | 0xFF] (changeOnly) 
-     *   +--> 0x01 0x01 [0x00 | 0xFF] (returnRCs)
-     * </pre> 
+     *   +--&gt; 0x02 0x0(1-4) [0..2^31-1] (changeTypes) 
+     *   +--&gt; 0x01 0x01 [0x00 | 0xFF] (changeOnly) 
+     *   +--&gt; 0x01 0x01 [0x00 | 0xFF] (returnRCs)
+     * </pre>
+     *  
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesDecorator.java Fri Sep  2 13:37:20 2016
@@ -48,6 +48,8 @@ public class SubentriesDecorator extends
 
     /**
      * Default constructor
+     * 
+     * @param codec The LDAP service instance
      */
     public SubentriesDecorator( LdapApiService codec )
     {
@@ -59,6 +61,7 @@ public class SubentriesDecorator extends
      * Creates a Subentries decorating implementation for use with the codec,
      * while decorating the supplied Subentries control.
      *
+     * @param codec The LDAP service instance
      * @param control The Subentries Control to wrap with this decorator.
      */
     public SubentriesDecorator( LdapApiService codec, Subentries control )
@@ -68,7 +71,12 @@ public class SubentriesDecorator extends
 
 
     /**
-     * Compute the SubEntryControl length 0x01 0x01 [0x00|0xFF]
+     * Compute the SubEntryControl length 
+     * <pre>
+     * 0x01 0x01 [0x00|0xFF]
+     * </pre>
+     * 
+     * @return the control length.
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesFactory.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesFactory.java Fri Sep  2 13:37:20 2016
@@ -42,7 +42,7 @@ public class SubentriesFactory implement
     /**
      * Creates a new instance of SubentriesFactory.
      *
-     * @param codec
+     * @param codec The LDAP service instance
      */
     public SubentriesFactory( LdapApiService codec )
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -83,7 +83,7 @@ public class SortRequestDecorator extend
 
 
     /**
-     * 
+     * @return the control length.
      */
     @Override
     public int computeLength()

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -74,7 +74,7 @@ public class SortResponseDecorator exten
 
 
     /**
-     * 
+     * @return the control length.
      */
     @Override
     public int computeLength()

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -42,6 +42,7 @@ public final class AbandonRequestDecorat
     /**
      * Makes a AddRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated AddRequest
      */
     public AbandonRequestDecorator( LdapApiService codec, AbandonRequest decoratedMessage )
@@ -145,11 +146,13 @@ public final class AbandonRequestDecorat
 
     /**
      * Compute the AbandonRequest length 
-     * 
-     * AbandonRequest : 
+     * <br>
+     * AbandonRequest :
+     * <pre> 
      * 0x50 0x0(1..4) abandoned MessageId 
      * 
      * Length(AbandonRequest) = Length(0x50) + 1 + Length(abandoned MessageId)
+     * </pre>
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -37,6 +37,7 @@ public abstract class AbandonableRequest
     /**
      * Makes Request a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated message
      */
     public AbandonableRequestDecorator( LdapApiService codec, M decoratedMessage )

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableResultResponseRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableResultResponseRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableResultResponseRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AbandonableResultResponseRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -36,6 +36,7 @@ public abstract class AbandonableResultR
     /**
      * Makes Request a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated message
      */
     public AbandonableResultResponseRequestDecorator( LdapApiService codec, M decoratedMessage )

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -76,6 +76,7 @@ public final class AddRequestDecorator e
     /**
      * Makes a AddRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated AddRequest
      */
     public AddRequestDecorator( LdapApiService codec, AddRequest decoratedMessage )
@@ -170,6 +171,7 @@ public final class AddRequestDecorator e
      * Create a new attributeValue
      * 
      * @param type The attribute's name (called 'type' in the grammar)
+     * @throws LdapException If the value is invalid
      */
     public void addAttributeType( String type ) throws LdapException
     {
@@ -199,6 +201,7 @@ public final class AddRequestDecorator e
      * Add a new value to the current attribute
      * 
      * @param value The value to add
+     * @throws LdapException If the value is invalid
      */
     public void addAttributeValue( String value ) throws LdapException
     {
@@ -210,6 +213,7 @@ public final class AddRequestDecorator e
      * Add a new value to the current attribute
      * 
      * @param value The value to add
+     * @throws LdapException If the value is invalid
      */
     public void addAttributeValue( Value value ) throws LdapException
     {
@@ -221,6 +225,7 @@ public final class AddRequestDecorator e
      * Add a new value to the current attribute
      * 
      * @param value The value to add
+     * @throws LdapException If the value is invalid
      */
     public void addAttributeValue( byte[] value ) throws LdapException
     {
@@ -233,42 +238,43 @@ public final class AddRequestDecorator e
     //-------------------------------------------------------------------------
     /**
      * Compute the AddRequest length
-     * 
+     * <br>
      * AddRequest :
-     * 
+     * <pre>
      * 0x68 L1
      *  |
-     *  +--> 0x04 L2 entry
-     *  +--> 0x30 L3 (attributes)
+     *  +--&gt; 0x04 L2 entry
+     *  +--&gt; 0x30 L3 (attributes)
      *        |
-     *        +--> 0x30 L4-1 (attribute)
+     *        +--&gt; 0x30 L4-1 (attribute)
      *        |     |
-     *        |     +--> 0x04 L5-1 type
-     *        |     +--> 0x31 L6-1 (values)
+     *        |     +--&gt; 0x04 L5-1 type
+     *        |     +--&gt; 0x31 L6-1 (values)
      *        |           |
-     *        |           +--> 0x04 L7-1-1 value
-     *        |           +--> ...
-     *        |           +--> 0x04 L7-1-n value
+     *        |           +--&gt; 0x04 L7-1-1 value
+     *        |           +--&gt; ...
+     *        |           +--&gt; 0x04 L7-1-n value
      *        |
-     *        +--> 0x30 L4-2 (attribute)
+     *        +--&gt; 0x30 L4-2 (attribute)
      *        |     |
-     *        |     +--> 0x04 L5-2 type
-     *        |     +--> 0x31 L6-2 (values)
+     *        |     +--&gt; 0x04 L5-2 type
+     *        |     +--&gt; 0x31 L6-2 (values)
      *        |           |
-     *        |           +--> 0x04 L7-2-1 value
-     *        |           +--> ...
-     *        |           +--> 0x04 L7-2-n value
+     *        |           +--&gt; 0x04 L7-2-1 value
+     *        |           +--&gt; ...
+     *        |           +--&gt; 0x04 L7-2-n value
      *        |
-     *        +--> ...
+     *        +--&gt; ...
      *        |
-     *        +--> 0x30 L4-m (attribute)
+     *        +--&gt; 0x30 L4-m (attribute)
      *              |
-     *              +--> 0x04 L5-m type
-     *              +--> 0x31 L6-m (values)
+     *              +--&gt; 0x04 L5-m type
+     *              +--&gt; 0x31 L6-m (values)
      *                    |
-     *                    +--> 0x04 L7-m-1 value
-     *                    +--> ...
-     *                    +--> 0x04 L7-m-n value
+     *                    +--&gt; 0x04 L7-m-1 value
+     *                    +--&gt; ...
+     *                    +--&gt; 0x04 L7-m-n value
+     * </pre>
      */
     public int computeLength()
     {
@@ -352,9 +358,9 @@ public final class AddRequestDecorator e
 
     /**
      * Encode the AddRequest message to a PDU.
-     * 
+     * <br>
      * AddRequest :
-     * 
+     * <pre>
      * 0x68 LL
      *   0x04 LL entry
      *   0x30 LL attributesList
@@ -371,6 +377,7 @@ public final class AddRequestDecorator e
      *         0x04 LL attributeValue
      *         ...
      *         0x04 LL attributeValue
+     * </pre>
      * 
      * @param buffer The buffer where to put the PDU
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/AddResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -45,6 +45,7 @@ public class AddResponseDecorator extend
     /**
      * Makes a AddResponse a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated AddResponse
      */
     public AddResponseDecorator( LdapApiService codec, AddResponse decoratedMessage )
@@ -67,16 +68,17 @@ public class AddResponseDecorator extend
     //-------------------------------------------------------------------------
     /**
      * Compute the AddResponse length 
-     * 
+     * <br>
      * AddResponse : 
-     * 
+     * <pre>
      * 0x69 L1
      *  |
-     *  +--> LdapResult
+     *  +--&gt; LdapResult
      * 
      * L1 = Length(LdapResult)
      * 
      * Length(AddResponse) = Length(0x69) + Length(L1) + L1
+     * </pre>
      */
     public int computeLength()
     {
@@ -92,7 +94,8 @@ public class AddResponseDecorator extend
      * Encode the AddResponse message to a PDU.
      * 
      * @param buffer The buffer where to put the PDU
-     * @param addResponseDecorator the AddResponse decorator
+     * @return The encoded response
+     * @throws EncoderException If teh encoding failed
      */
     public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -64,6 +64,7 @@ public class BindRequestDecorator extend
     /**
      * Makes a BindRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated BindRequests.
      */
     public BindRequestDecorator( LdapApiService codec, BindRequest decoratedMessage )
@@ -268,14 +269,14 @@ public class BindRequestDecorator extend
     //-------------------------------------------------------------------------
     /**
      * Compute the BindRequest length
-     * 
+     * <br>
      * BindRequest :
      * <pre>
      * 0x60 L1
      *   |
-     *   +--> 0x02 0x01 (1..127) version
-     *   +--> 0x04 L2 name
-     *   +--> authentication
+     *   +--&gt; 0x02 0x01 (1..127) version
+     *   +--&gt; 0x04 L2 name
+     *   +--&gt; authentication
      * 
      * L2 = Length(name)
      * L3/4 = Length(authentication)
@@ -351,7 +352,7 @@ public class BindRequestDecorator extend
 
     /**
      * Encode the BindRequest message to a PDU.
-     * 
+     * <br>
      * BindRequest :
      * <pre>
      * 0x60 LL

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/BindResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -45,6 +45,7 @@ public class BindResponseDecorator exten
     /**
      * Makes a BindResponse a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated BindResponse
      */
     public BindResponseDecorator( LdapApiService codec, BindResponse decoratedMessage )
@@ -80,13 +81,13 @@ public class BindResponseDecorator exten
     //-------------------------------------------------------------------------
     /**
      * Compute the BindResponse length 
-     * 
+     * <br>
      * BindResponse : 
      * <pre>
      * 0x61 L1 
      *   | 
-     *   +--> LdapResult
-     *   +--> [serverSaslCreds] 
+     *   +--&gt; LdapResult
+     *   +--&gt; [serverSaslCreds] 
      *   
      * L1 = Length(LdapResult) [ + Length(serverSaslCreds) ] 
      * Length(BindResponse) = Length(0x61) + Length(L1) + L1
@@ -112,15 +113,15 @@ public class BindResponseDecorator exten
 
     /**
      * Encode the BindResponse message to a PDU.
-     * 
+     * <br>
      * BindResponse :
      * <pre>
      * LdapResult.encode 
      * [0x87 LL serverSaslCreds]
      * </pre>
      * 
-     * @param bb The buffer where to put the PDU
-     * @param bindResponseDecorator The decorated BindResponse to encode
+     * @param buffer The buffer where to put the PDU
+     * @return The encoded response
      * @throws EncoderException when encoding operations fail
      */
     public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -64,6 +64,7 @@ public class CompareRequestDecorator ext
     /**
      * Makes a CompareRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated CompareRequest
      */
     public CompareRequestDecorator( LdapApiService codec, CompareRequest decoratedMessage )
@@ -190,20 +191,22 @@ public class CompareRequestDecorator ext
     //-------------------------------------------------------------------------
     /**
      * Compute the CompareRequest length
-     * 
+     * <br>
      * CompareRequest :
+     * <pre>
      * 0x6E L1
      *   |
-     *   +--> 0x04 L2 entry
-     *   +--> 0x30 L3 (ava)
+     *   +--&gt; 0x04 L2 entry
+     *   +--&gt; 0x30 L3 (ava)
      *         |
-     *         +--> 0x04 L4 attributeDesc
-     *         +--> 0x04 L5 assertionValue
+     *         +--&gt; 0x04 L4 attributeDesc
+     *         +--&gt; 0x04 L5 assertionValue
      * 
      * L3 = Length(0x04) + Length(L4) + L4 + Length(0x04) +
      *      Length(L5) + L5
      * Length(CompareRequest) = Length(0x6E) + Length(L1) + L1 +
      *      Length(0x04) + Length(L2) + L2 + Length(0x30) + Length(L3) + L3
+     * </pre>
      * 
      * @return The CompareRequest PDU's length
      */
@@ -238,13 +241,14 @@ public class CompareRequestDecorator ext
 
     /**
      * Encode the CompareRequest message to a PDU.
-     * 
+     * <pre>
      * CompareRequest :
      *   0x6E LL
      *     0x04 LL entry
      *     0x30 LL attributeValueAssertion
      *       0x04 LL attributeDesc
      *       0x04 LL assertionValue
+     * </pre>
      * 
      * @param buffer The buffer where to put the PDU
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/CompareResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -46,6 +46,7 @@ public class CompareResponseDecorator ex
     /**
      * Makes a CompareResponse a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated CompareResponse
      */
     public CompareResponseDecorator( LdapApiService codec, CompareResponse decoratedMessage )
@@ -73,16 +74,17 @@ public class CompareResponseDecorator ex
 
     /**
      * Compute the CompareResponse length 
-     * 
+     * <br>
      * CompareResponse :
-     * 
+     * <pre>
      * 0x6F L1
      *  |
-     *  +--> LdapResult
+     *  +--&gt; LdapResult
      * 
      * L1 = Length(LdapResult)
      * 
      * Length(CompareResponse) = Length(0x6F) + Length(L1) + L1
+     * </pre>
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -49,6 +49,7 @@ public class DeleteRequestDecorator exte
     /**
      * Makes a DeleteRequest a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated DeleteRequest
      */
     public DeleteRequestDecorator( LdapApiService codec, DeleteRequest decoratedMessage )
@@ -124,12 +125,14 @@ public class DeleteRequestDecorator exte
     //-------------------------------------------------------------------------
     /**
      * Compute the DelRequest length
-     * 
+     * <br>
      * DelRequest :
+     * <pre>
      * 0x4A L1 entry
      * 
      * L1 = Length(entry)
      * Length(DelRequest) = Length(0x4A) + Length(L1) + L1
+     * </pre>
      */
     public int computeLength()
     {
@@ -143,9 +146,11 @@ public class DeleteRequestDecorator exte
 
     /**
      * Encode the DelRequest message to a PDU.
-     * 
+     * <br>
      * DelRequest :
+     * <pre>
      * 0x4A LL entry
+     * </pre>
      * 
      * @param buffer The buffer where to put the PDU
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/DeleteResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -46,6 +46,7 @@ public class DeleteResponseDecorator ext
     /**
      * Makes a DeleteResponse a MessageDecorator.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated DeleteResponse
      */
     public DeleteResponseDecorator( LdapApiService codec, DeleteResponse decoratedMessage )
@@ -60,16 +61,17 @@ public class DeleteResponseDecorator ext
 
     /**
      * Compute the DelResponse length 
-     * 
+     * <br>
      * DelResponse :
-     * 
+     * <pre>
      * 0x6B L1
      *  |
-     *  +--> LdapResult
+     *  +--&gt; LdapResult
      * 
      * L1 = Length(LdapResult)
      * 
      * Length(DelResponse) = Length(0x6B) + Length(L1) + L1
+     * </pre>
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/IntermediateResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/IntermediateResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/IntermediateResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/IntermediateResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -54,6 +54,7 @@ public class IntermediateResponseDecorat
     /**
      * Makes a IntermediateResponse encodable.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated IntermediateResponse
      */
     public IntermediateResponseDecorator( LdapApiService codec, IntermediateResponse decoratedMessage )
@@ -107,18 +108,19 @@ public class IntermediateResponseDecorat
     //-------------------------------------------------------------------------
     /**
      * Compute the intermediateResponse length
-     * 
+     * <br>
      * intermediateResponse :
-     * 
+     * <pre>
      * 0x79 L1
      *  |
-     * [+--> 0x80 L2 name
-     * [+--> 0x81 L3 response]]
+     * [+--&gt; 0x80 L2 name
+     * [+--&gt; 0x81 L3 response]]
      * 
      * L1 = [ + Length(0x80) + Length(L2) + L2
      *      [ + Length(0x81) + Length(L3) + L3]]
      * 
      * Length(IntermediateResponse) = Length(0x79) + Length(L1) + L1
+     * </pre>
      * 
      * @return The IntermediateResponse length
      */
@@ -147,10 +149,13 @@ public class IntermediateResponseDecorat
 
     /**
      * Encode the IntermediateResponse message to a PDU. 
+     * <br>
      * IntermediateResponse :
+     * <pre>
      *   0x79 LL
      *     [0x80 LL response name]
      *     [0x81 LL responseValue]
+     * </pre>
      * 
      * @param buffer The buffer where to put the PDU
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/LdapResultDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/LdapResultDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/LdapResultDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/LdapResultDecorator.java Fri Sep  2 13:37:20 2016
@@ -63,6 +63,7 @@ public class LdapResultDecorator impleme
     /**
      * Makes a LdapResult encodable.
      *
+     * @param codec The LDAP service instance
      * @param decoratedLdapResult the decorated LdapResult
      */
     public LdapResultDecorator( LdapApiService codec, LdapResult decoratedLdapResult )
@@ -171,19 +172,20 @@ public class LdapResultDecorator impleme
     //-------------------------------------------------------------------------
     /**
      * Compute the LdapResult length 
-     * 
-     * LdapResult : 
+     * <br>
+     * LdapResult :
+     * <pre> 
      *   0x0A 01 resultCode (0..80)
      *   0x04 L1 matchedDN (L1 = Length(matchedDN)) 
      *   0x04 L2 errorMessage (L2 = Length(errorMessage)) 
      *   [0x83 L3] referrals 
      *     | 
-     *     +--> 0x04 L4 referral 
-     *     +--> 0x04 L5 referral 
-     *     +--> ... 
-     *     +--> 0x04 Li referral 
-     *     +--> ... 
-     *     +--> 0x04 Ln referral 
+     *     +--&gt; 0x04 L4 referral 
+     *     +--&gt; 0x04 L5 referral 
+     *     +--&gt; ... 
+     *     +--&gt; 0x04 Li referral 
+     *     +--&gt; ... 
+     *     +--&gt; 0x04 Ln referral 
      *     
      * L1 = Length(matchedDN) 
      * L2 = Length(errorMessage) 
@@ -192,6 +194,7 @@ public class LdapResultDecorator impleme
      * Length(LdapResult) = Length(0x0x0A) +
      *      Length(0x01) + 1 + Length(0x04) + Length(L1) + L1 + Length(0x04) +
      *      Length(L2) + L2 + Length(0x83) + Length(L3) + L3
+     * </pre>
      */
     public int computeLength()
     {

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnRequestDecorator.java Fri Sep  2 13:37:20 2016
@@ -57,6 +57,7 @@ public class ModifyDnRequestDecorator ex
     /**
      * Makes a ModifyDnRequest encodable.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated ModifyDnRequest
      */
     public ModifyDnRequestDecorator( LdapApiService codec, ModifyDnRequest decoratedMessage )
@@ -202,15 +203,15 @@ public class ModifyDnRequestDecorator ex
 
     /**
      * Compute the ModifyDNRequest length
-     * 
+     * <br>
      * ModifyDNRequest :
      * <pre>
      * 0x6C L1
      *  |
-     *  +--> 0x04 L2 entry
-     *  +--> 0x04 L3 newRDN
-     *  +--> 0x01 0x01 (true/false) deleteOldRDN (3 bytes)
-     * [+--> 0x80 L4 newSuperior ] 
+     *  +--&gt; 0x04 L2 entry
+     *  +--&gt; 0x04 L3 newRDN
+     *  +--&gt; 0x01 0x01 (true/false) deleteOldRDN (3 bytes)
+     * [+--&gt; 0x80 L4 newSuperior ] 
      * 
      * L2 = Length(0x04) + Length(Length(entry)) + Length(entry) 
      * L3 = Length(0x04) + Length(Length(newRDN)) + Length(newRDN) 
@@ -244,7 +245,7 @@ public class ModifyDnRequestDecorator ex
 
     /**
      * Encode the ModifyDNRequest message to a PDU. 
-     * 
+     * <br>
      * ModifyDNRequest :
      * <pre>
      * 0x6C LL
@@ -253,6 +254,7 @@ public class ModifyDnRequestDecorator ex
      *   0x01 0x01 deleteOldRDN
      *   [0x80 LL newSuperior]
      * </pre>
+     * 
      * @param buffer The buffer where to put the PDU
      * @return The PDU.
      */

Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyDnResponseDecorator.java Fri Sep  2 13:37:20 2016
@@ -46,6 +46,7 @@ public class ModifyDnResponseDecorator e
     /**
      * Makes a ModifyDnResponse encodable.
      *
+     * @param codec The LDAP service instance
      * @param decoratedMessage the decorated ModifyDnResponse
      */
     public ModifyDnResponseDecorator( LdapApiService codec, ModifyDnResponse decoratedMessage )
@@ -59,12 +60,12 @@ public class ModifyDnResponseDecorator e
     //-------------------------------------------------------------------------
     /**
      * Compute the ModifyDNResponse length 
-     * 
+     * <br>
      * ModifyDNResponse : 
      * <pre>
      * 0x6D L1 
      *   | 
-     *   +--> LdapResult 
+     *   +--&gt; LdapResult 
      *   
      * L1 = Length(LdapResult) 
      * Length(ModifyDNResponse) = Length(0x6D) + Length(L1) + L1




Mime
View raw message