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

(directory-ldap-api) branch master updated: Fixed many javadoc warnings

This is an automated email from the ASF dual-hosted git repository.

elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-ldap-api.git


The following commit(s) were added to refs/heads/master by this push:
     new 24def8af2 Fixed many javadoc warnings
24def8af2 is described below

commit 24def8af2daf5303dc1daebae468716cd1c8a76b
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Sat Jan 11 06:59:50 2025 +0100

    Fixed many javadoc warnings
---
 .../org/apache/directory/api/asn1/ber/Asn1Container.java | 11 +++++++++++
 .../directory/api/asn1/ber/grammar/AbstractGrammar.java  |  1 +
 .../apache/directory/api/asn1/ber/grammar/Grammar.java   |  2 ++
 .../api/asn1/ber/grammar/GrammarTransition.java          | 10 ++++++++++
 .../apache/directory/api/asn1/ber/grammar/States.java    |  4 ++++
 .../org/apache/directory/api/asn1/ber/tlv/BerValue.java  |  2 ++
 .../directory/api/asn1/ber/tlv/BooleanDecoder.java       |  4 +++-
 .../directory/api/asn1/ber/tlv/IntegerDecoder.java       |  4 +++-
 .../apache/directory/api/asn1/ber/tlv/LongDecoder.java   |  4 +++-
 .../java/org/apache/directory/api/asn1/ber/tlv/TLV.java  | 16 +++++++++++++++-
 .../apache/directory/api/asn1/ber/tlv/UniversalTag.java  |  2 ++
 .../api/dsmlv2/AbstractDsmlMessageDecorator.java         |  2 ++
 .../api/dsmlv2/request/AbstractRequestDsml.java          |  2 ++
 .../ldap/client/api/Krb5LoginConfiguration.java          |  4 ++--
 .../api/search/MatchingRuleAssertionFilterBuilder.java   |  1 +
 .../directory/api/ldap/codec/api/ControlFactory.java     |  2 ++
 .../search/entryChange/EntryChangeContainer.java         |  2 ++
 .../persistentSearch/PersistentSearchContainer.java      |  2 ++
 .../controls/search/subentries/SubentriesContainer.java  |  2 ++
 .../ldap/codec/standalone/StandaloneLdapApiService.java  |  3 +++
 ldap/extras/aci/pom.xml                                  | 10 ++++++++++
 21 files changed, 84 insertions(+), 6 deletions(-)

diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java
index de08f1142..ef51476c8 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java
@@ -116,6 +116,7 @@ public interface Asn1Container
 
 
     /**
+     * Get the parent's TLV
      * @return The parent TLV.
      */
     TLV getParentTLV();
@@ -161,6 +162,8 @@ public interface Asn1Container
 
 
     /**
+     * Get the size of the decoded message
+     * 
      * @return The number of decoded bytes for this message. This is used
      * to control the PDU size and avoid PDU exceeding the maximum allowed
      * size to break the server.
@@ -169,6 +172,8 @@ public interface Asn1Container
 
 
     /**
+     * Set the size of the decoded messagz
+     * 
      * @param decodedBytes The number of decoded bytes for this message.
      */
     void setDecodedBytes( int decodedBytes );
@@ -176,12 +181,15 @@ public interface Asn1Container
 
     /**
      * Increment the decodedBytes by the latest received buffer's size.
+     * 
      * @param nb The buffer size.
      */
     void incrementDecodedBytes( int nb );
 
 
     /**
+     * Get the maximum PDU size allowed
+     * 
      * @return The maximum PDU size.
      */
     int getMaxPDUSize();
@@ -189,6 +197,7 @@ public interface Asn1Container
 
     /**
      * Set the maximum PDU size.
+     * 
      * @param maxPDUSize The maximum PDU size (if negative or null, will be
      * replaced by the max integer value)
      */
@@ -210,6 +219,8 @@ public interface Asn1Container
 
 
     /**
+     * Tells if the decoding should be done immediately or if the container should gather the data before
+     * 
      * @return true if the container should gather the value into itself, false
      * if the decoding of the Value part should be done immediately for
      * constructed types.
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java
index bdc988134..6478e4dfa 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java
@@ -56,6 +56,7 @@ public abstract class AbstractGrammar<C extends Asn1Container> implements Gramma
     /** Default constructor */
     public AbstractGrammar()
     {
+        // Nothing to do
     }
 
 
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java
index efb39820a..09e78c2c5 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java
@@ -36,8 +36,10 @@ public interface Grammar<C extends Asn1Container>
     /** The flag used to tell if a given state must have a follow up in the same PDU or not */
     enum FollowUp
     {
+        /** When a following state is mandatory */
         MANDATORY,
         
+        /** When a following state is optional */
         OPTIONAL;
     }
     
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java
index 98b13500d..103cd88c6 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java
@@ -136,6 +136,8 @@ public class GrammarTransition<C extends Asn1Container>
 
 
     /**
+     * Get the transition's action
+     * 
      * @return Returns the action associated with the transition
      */
     public Action<C> getAction()
@@ -145,6 +147,8 @@ public class GrammarTransition<C extends Asn1Container>
 
 
     /**
+     * Get the current state
+     * 
      * @return The current state
      */
     public Enum<?> getCurrentState()
@@ -154,6 +158,8 @@ public class GrammarTransition<C extends Asn1Container>
 
 
     /**
+     * Get the previous state
+     * 
      * @return The previous state
      */
     public Enum<?> getPreviousState()
@@ -163,6 +169,8 @@ public class GrammarTransition<C extends Asn1Container>
 
 
     /**
+     * Get the followUp flag
+     * 
      * @return the followUp flag
      */
     public boolean hasFollowUp()
@@ -172,6 +180,8 @@ public class GrammarTransition<C extends Asn1Container>
 
 
     /**
+     * Set the followUp flag
+     * 
      * @param followUp the followUp flag to set
      */
     public void setFollowUp( FollowUp followUp )
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/States.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/States.java
index 3c98bd12d..9dee8509c 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/States.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/States.java
@@ -28,12 +28,16 @@ package org.apache.directory.api.asn1.ber.grammar;
 public interface States
 {
     /**
+     * Tells if this is an end state
+     * 
      * @return True if this is the END_STATE
      */
     boolean isEndState();
 
 
     /**
+     * Get the starting state
+     * 
      * @return The START_STATE of the enum
      */
     Enum<?> getStartState();
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java
index 7c00adee2..15693a897 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java
@@ -210,6 +210,8 @@ public class BerValue
 
 
     /**
+     * Get the current length
+     * 
      * @return The number of bytes actually stored
      */
     public int getCurrentLength()
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BooleanDecoder.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BooleanDecoder.java
index 45258360c..01249301e 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BooleanDecoder.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BooleanDecoder.java
@@ -36,7 +36,9 @@ public final class BooleanDecoder
     /** The logger */
     private static final Logger LOG = LoggerFactory.getLogger( BooleanDecoder.class );
 
-
+    /**
+     * A private constructor
+     */
     private BooleanDecoder()
     {
     }
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/IntegerDecoder.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/IntegerDecoder.java
index 725c00f5f..d28b1ef7d 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/IntegerDecoder.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/IntegerDecoder.java
@@ -35,7 +35,9 @@ public final class IntegerDecoder
     private static final int[] MASK = new int[]
         { 0x000000FF, 0x0000FFFF, 0x00FFFFFF, 0xFFFFFFFF };
 
-
+    /**
+     * A private constructor
+     */
     private IntegerDecoder()
     {
     }
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java
index 9b546c254..ad57cf9ab 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java
@@ -35,7 +35,9 @@ public final class LongDecoder
         { 0x00000000000000FFL, 0x000000000000FFFFL, 0x0000000000FFFFFFL, 0x00000000FFFFFFFFL, 0x000000FFFFFFFFFFL,
             0x0000FFFFFFFFFFFFL, 0x00FFFFFFFFFFFFFFL, 0xFFFFFFFFFFFFFFFFL };
 
-
+    /**
+     * A private constructor
+     */
     private LongDecoder()
     {
     }
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/TLV.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/TLV.java
index 37f4ee8c3..9c0422c89 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/TLV.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/TLV.java
@@ -176,6 +176,8 @@ public class TLV
 
 
     /**
+     * Get the TLV's tag
+     * 
      * @return Returns the tag.
      */
     public byte getTag()
@@ -196,6 +198,8 @@ public class TLV
 
 
     /**
+     * Get the TLV's value part
+     * 
      * @return Returns the value.
      */
     public BerValue getValue()
@@ -320,6 +324,8 @@ public class TLV
 
 
     /**
+     * Get the TLV's parent
+     * 
      * @return The parent.
      */
     public TLV getParent()
@@ -329,6 +335,8 @@ public class TLV
 
 
     /**
+     * Set the TLV's parent
+     * 
      * @param parent The parent to set.
      */
     public void setParent( TLV parent )
@@ -360,6 +368,8 @@ public class TLV
 
 
     /**
+     * Get the TLV's length
+     * 
      * @return The number of bytes necessary to store the TLV's length
      */
     public int getLengthNbBytes()
@@ -380,6 +390,7 @@ public class TLV
 
 
     /**
+     * Get the TLV's length
      * @return the TLV's length
      */
     public int getLength()
@@ -400,6 +411,8 @@ public class TLV
 
 
     /**
+     * Get the already read bytes
+     * 
      * @return The currently read TLV's length bytes
      */
     public int getLengthBytesRead()
@@ -421,7 +434,6 @@ public class TLV
 
     /**
      * Increment the number of bytes read for this TLV
-     *
      */
     public void incLengthBytesRead()
     {
@@ -430,6 +442,8 @@ public class TLV
 
 
     /**
+     * Get the TLV's ID
+     * 
      * @return The TLV's ID
      */
     public int getId()
diff --git a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java
index 9e0f9da98..1a836e0ce 100644
--- a/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java
+++ b/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java
@@ -286,6 +286,8 @@ public enum UniversalTag
 
 
     /**
+     * Get the UniversalTag value
+     * 
      * @return The UniversalTag value
      */
     public byte getValue()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractDsmlMessageDecorator.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractDsmlMessageDecorator.java
index 87b2379da..b3da4838f 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractDsmlMessageDecorator.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractDsmlMessageDecorator.java
@@ -78,6 +78,8 @@ public abstract class AbstractDsmlMessageDecorator<M extends Message>
 
 
     /**
+     * Get the codec service
+     * 
      * @return The codec to use to encode or decode this message
      */
     public LdapApiService getCodecService()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java
index 0a868e135..82bcf8caa 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java
@@ -122,6 +122,8 @@ public abstract class AbstractRequestDsml<E extends Request>
 
 
     /**
+     * Get the length of the encoded request
+     * 
      * @return the buffer's length (always 0)
      */
     public int computeLength()
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/Krb5LoginConfiguration.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/Krb5LoginConfiguration.java
index 05b56c4ec..3584d24a4 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/Krb5LoginConfiguration.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/Krb5LoginConfiguration.java
@@ -28,15 +28,15 @@ import javax.security.auth.login.Configuration;
 
 
 /**
+ * The JAAS Login Configuration File for Kerberos
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class Krb5LoginConfiguration extends Configuration
 {
-
     /** The list with configuration entries. */
     private static AppConfigurationEntry[] configList = new AppConfigurationEntry[1];
 
-
     /**
      * Creates a new instance of Krb5LoginConfiguration.
      */
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/MatchingRuleAssertionFilterBuilder.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/MatchingRuleAssertionFilterBuilder.java
index a6497bf8e..7c85774a4 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/MatchingRuleAssertionFilterBuilder.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/MatchingRuleAssertionFilterBuilder.java
@@ -21,6 +21,7 @@ package org.apache.directory.ldap.client.api.search;
 
 
 /**
+ * The filter buildee for MatchingRuleAssertion
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
index 15aaf84ed..b1e9ba72e 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
@@ -38,6 +38,8 @@ import org.apache.directory.api.ldap.model.message.Control;
 public interface ControlFactory<C extends Control>
 {
     /**
+     * Get the control's OID
+     * 
      * @return The OID of the Control this factory creates.
      */
     String getOid();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
index ed0c0d714..3e5fa0ce7 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.model.message.controls.EntryChange;
 
 
 /**
+ * The EntryChange control ASN1 Container.
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class EntryChangeContainer extends AbstractContainer implements ControlContainer
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
index 5ccfcb028..2afc368b2 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.model.message.controls.PersistentSearch;
 
 
 /**
+ * The PersistentSearch control ASN1 Container.
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class PersistentSearchContainer extends AbstractContainer implements ControlContainer
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
index d37b0eb13..5cbe3949b 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.model.message.controls.Subentries;
 
 
 /**
+ * The SubEntries control ASN1 Container.
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class SubentriesContainer extends AbstractContainer implements ControlContainer
diff --git a/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java b/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
index fb56e4a98..b35a8ef55 100644
--- a/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
+++ b/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
@@ -93,7 +93,10 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
     /** The control's type */
     public enum ControlType
     {
+        /** A Request control type */
         REQUEST( REQUEST_CONTROLS_LIST ),
+
+        /** A Response control type */
         RESPONSE( RESPONSE_CONTROLS_LIST );
         
         private String property;
diff --git a/ldap/extras/aci/pom.xml b/ldap/extras/aci/pom.xml
index 5926937de..3e3158c91 100644
--- a/ldap/extras/aci/pom.xml
+++ b/ldap/extras/aci/pom.xml
@@ -69,6 +69,16 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+          <sourceFileExcludes>
+            <sourceFileExclude>**/Antlr*</sourceFileExclude>
+          </sourceFileExcludes>
+        </configuration>
+      </plugin>
+      
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>antlr-maven-plugin</artifactId>