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 2018/08/02 08:38:13 UTC
[directory-ldap-api] branch master updated: Fixed many Javadoc
issues
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 9d2a81e Fixed many Javadoc issues
9d2a81e is described below
commit 9d2a81e10be7aba3cd5b524b6e1323b2986c578a
Author: Emmanuel Lécharny <el...@symas.com>
AuthorDate: Thu Aug 2 10:38:08 2018 +0200
Fixed many Javadoc issues
---
.../apache/directory/api/dsmlv2/Dsmlv2Parser.java | 2 +-
.../directory/api/dsmlv2/Dsmlv2ResponseParser.java | 2 +-
.../api/dsmlv2/request/SearchRequestDsml.java | 1 +
.../api/dsmlv2/response/Dsmlv2ResponseGrammar.java | 4 ++--
.../codec/api/IntermediateResponseFactory.java | 2 +-
.../directory/api/ldap/codec/api/LdapEncoder.java | 8 +++++++
.../codec/standalone/StandaloneLdapApiService.java | 28 ++++++++++++++++++++--
ldap/extras/aci/src/main/antlr/ACIItem.g | 5 +++-
ldap/extras/aci/src/main/antlr/ACIItemChecker.g | 5 ++--
.../directory/api/ldap/aci/ACIItemChecker.java | 2 ++
.../directory/api/ldap/aci/ACIItemParser.java | 4 +++-
.../api/ldap/aci/ReusableAntlrACIItemChecker.java | 2 ++
.../api/ldap/aci/ReusableAntlrACIItemParser.java | 2 ++
.../api/ldap/extras/controls/SyncModifyDnType.java | 2 ++
.../api/ldap/extras/controls/ad/AdDirSyncFlag.java | 7 +++++-
.../controls/ppolicy/PasswordPolicyImpl.java | 1 +
.../transaction/TransactionSpecification.java | 2 +-
.../endTransaction/EndTransactionResponse.java | 2 +-
.../endTransaction/EndTransactionResponseImpl.java | 2 +-
.../StartTransactionResponseImpl.java | 2 +-
.../ads_impl/cancel/CancelRequestDecorator.java | 2 ++
.../CertGenerationRequestDecorator.java | 2 ++
.../EndTransactionRequestDecorator.java | 2 ++
.../EndTransactionResponseDecorator.java | 4 +++-
.../GracefulDisconnectResponseDecorator.java | 10 ++++----
.../GracefulShutdownRequestDecorator.java | 2 ++
.../pwdModify/PasswordModifyRequestDecorator.java | 3 ++-
.../pwdModify/PasswordModifyResponseDecorator.java | 3 ++-
.../StoredProcedureRequestDecorator.java | 2 ++
.../ads_impl/whoAmI/WhoAmIResponseDecorator.java | 8 ++++++-
.../syncrepl_impl/SyncInfoFactory.java | 2 ++
.../syncrepl_impl/SyncInfoValueFactory.java | 2 +-
.../api/ldap/model/filter/SimpleNode.java | 10 ++++----
.../directory/api/ldap/model/ldif/LdifEntry.java | 8 +++----
.../directory/api/ldap/model/ldif/LdifReader.java | 5 +++-
.../directory/api/ldap/model/ldif/LdifUtils.java | 7 ------
.../model/message/controls/PersistentSearch.java | 2 +-
.../model/message/extended/AddNoDResponse.java | 2 ++
.../model/message/extended/BindNoDResponse.java | 2 ++
.../model/message/extended/CompareNoDResponse.java | 2 ++
.../model/message/extended/DeleteNoDResponse.java | 2 ++
.../message/extended/ExtendedNoDResponse.java | 2 ++
.../message/extended/ModifyDnNoDResponse.java | 2 ++
.../model/message/extended/ModifyNoDResponse.java | 2 ++
.../model/message/extended/SearchNoDResponse.java | 2 ++
.../apache/directory/api/ldap/model/name/Ava.java | 28 +++++++++++++---------
.../directory/api/ldap/model/password/BCrypt.java | 11 +++++----
.../api/ldap/model/schema/ObjectClassTypeEnum.java | 5 +---
.../api/ldap/model/schema/PrepareString.java | 4 ----
.../ldap/model/schema/SchemaObjectRenderer.java | 6 +++--
.../api/ldap/model/schema/SchemaUtils.java | 11 +++++----
.../ldap/model/schema/registries/Registries.java | 19 +++------------
.../registries/helper/DitStructureRuleHelper.java | 2 --
.../schema/registries/helper/LdapSyntaxHelper.java | 1 -
.../registries/helper/MatchingRuleHelper.java | 1 -
.../registries/helper/ObjectClassHelper.java | 1 -
.../AttributeTypeUsageSyntaxChecker.java | 6 ++---
.../DeliveryMethodSyntaxChecker.java | 2 +-
.../schema/syntaxCheckers/DnSyntaxChecker.java | 1 +
.../schema/syntaxCheckers/JpegSyntaxChecker.java | 2 +-
.../NameAndOptionalUIDSyntaxChecker.java | 1 +
.../directory/api/ldap/model/url/LdapUrl.java | 1 -
.../codec/protocol/mina/LdapProtocolDecoder.java | 2 +-
.../schema/manager/impl/DefaultSchemaManager.java | 4 ++--
.../directory/api/util/SequencedHashMap.java | 13 ++++++++++
65 files changed, 192 insertions(+), 104 deletions(-)
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java
index 8192631..1b3fe78 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java
@@ -118,7 +118,7 @@ public class Dsmlv2Parser
* Sets the input file the parser is going to parse. Default charset is used.
*
* @param fileName the name of the file
- * @throws FileNotFoundException if the file does not exist
+ * @throws IOException if the file does not exist
* @throws XmlPullParserException if an error occurs in the parser
*/
public void setInputFile( String fileName ) throws IOException, XmlPullParserException
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java
index 54aeebd..150221f 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java
@@ -88,7 +88,7 @@ public class Dsmlv2ResponseParser
* Sets the input file the parser is going to parse. Default charset is used.
*
* @param fileName the name of the file
- * @throws FileNotFoundException if the file does not exist
+ * @throws IOException if the file does not exist
* @throws XmlPullParserException if an error occurs in the parser
*/
public void setInputFile( String fileName ) throws IOException, XmlPullParserException
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java
index be1fcfe..64014c0 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java
@@ -202,6 +202,7 @@ public class SearchRequestDsml
*
* @param filter The filter to be transformed
* @return An ExprNode
+ * @throws LdapSchemaException If the filter contains a wrong schema element
*/
@SuppressWarnings({ "rawtypes" })
private ExprNode transform( Filter filter ) throws LdapSchemaException
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/Dsmlv2ResponseGrammar.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/Dsmlv2ResponseGrammar.java
index 95444ed..5e66696 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/Dsmlv2ResponseGrammar.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/Dsmlv2ResponseGrammar.java
@@ -2053,7 +2053,7 @@ public final class Dsmlv2ResponseGrammar extends AbstractGrammar implements Gram
* Creates a Control Value parsing the current node and adds it to the given parent
* @param container the DSMLv2Container
* @param parent the parent
- * @throws XmlPullParserException
+ * @throws XmlPullParserException When the parsing fails
*/
private void createAndAddControlValue( Dsmlv2Container container,
AbstractDsmlMessageDecorator<? extends Message> parent )
@@ -2093,7 +2093,7 @@ public final class Dsmlv2ResponseGrammar extends AbstractGrammar implements Gram
* Creates a Control parsing the current node and adds it to the given parent
* @param container the DSMLv2Container
* @param parent the parent
- * @throws XmlPullParserException
+ * @throws XmlPullParserException When the parsing fails
*/
private void createAndAddControl( Dsmlv2Container container,
AbstractDsmlMessageDecorator<? extends Message> parent ) throws XmlPullParserException
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateResponseFactory.java
index b2120b6..bdcecad 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateResponseFactory.java
@@ -40,7 +40,7 @@ public interface IntermediateResponseFactory
/**
- * Returns a new {@link IntermediateResponseDecorator} with the following encoded value.
+ * Returns a new {@link IntermediateResponse} with the following encoded value.
*
* @param value the encoded value
* @return the decorator for the extended response type
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
index 620c560..d67c26b 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
@@ -66,6 +66,9 @@ public class LdapEncoder
/**
* Compute the control's encoded length
+ *
+ * @param control The control to compute
+ * @return the encoded control length
*/
public static int computeControlLength( Control control )
{
@@ -95,6 +98,10 @@ public class LdapEncoder
/**
* Encode a control to a byte[]
+ *
+ * @param buffer The buffer that will contain the encoded control
+ * @param control The control to encode
+ * @return The control encoded in a byte[]
*/
public static ByteBuffer encodeControl( ByteBuffer buffer, Control control ) throws EncoderException
{
@@ -235,6 +242,7 @@ public class LdapEncoder
* </pre>
*
* @param messageDecorator the decorated Message who's length is to be encoded
+ * @return The message length
*/
private int computeMessageLength( MessageDecorator<? extends Message> messageDecorator )
{
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 fcb78ec..1acb200 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
@@ -160,9 +160,11 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
*
* @param controls The list of controls to store
* @param extendedOperations The list of extended operations to store
+ * @param intermediateResponses The list of intermediate responsess to store
* @throws Exception If we had an issue with one of the two lists
*/
- public StandaloneLdapApiService( List<String> controls, List<String> extendedOperations, List<String> intermediateResponses ) throws Exception
+ public StandaloneLdapApiService( List<String> controls, List<String> extendedOperations,
+ List<String> intermediateResponses ) throws Exception
{
CodecFactoryUtil.loadStockControls( getControlFactories(), this );
@@ -209,7 +211,7 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Parses the system properties to obtain the controls list.
*
- * @throws Exception
+ * @return A list of controls
*/
private static List<String> getControlsFromSystemProperties()
{
@@ -247,6 +249,8 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
* Parses the system properties to obtain the extended operations.
* Such extended operations are stored in the <b>apacheds.extendedOperations</b>
* and <b>default.extendedOperation.requests</b> system properties.
+ *
+ * @return a list of extended operation
*/
private static List<String> getExtendedOperationsFromSystemProperties()
{
@@ -284,6 +288,8 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
* Parses the system properties to obtain the intermediate responses.
* Such intermediate responses are stored in the <b>apacheds.intermediateResponses</b>
* and <b>default.intermediateResponses.requests</b> system properties.
+ *
+ * @return a list of intermediate responses
*/
private static List<String> getIntermediateResponsesFromSystemProperties()
{
@@ -306,6 +312,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads a list of controls from their FQCN.
+ *
+ * @param controlsList The list of controls to load
+ * @throws Exception if a control could not be loaded
*/
private void loadControls( List<String> controlsList ) throws Exception
{
@@ -322,6 +331,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads a control from its FQCN.
+ *
+ * @param controlFQCN The control FQCN
+ * @throws Exception If the control could not be loaded
*/
private void loadControl( String controlFQCN ) throws Exception
{
@@ -356,6 +368,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads a list of extended operation from their FQCN
+ *
+ * @param extendedOperationsList The list of extended operations to load
+ * @throws Exception If an extended operations cannot be loaded
*/
private void loadExtendedOperations( List<String> extendedOperationsList ) throws Exception
{
@@ -372,6 +387,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads an of extended operations from its FQCN
+ *
+ * @param extendedOperationFQCN The extended operations to load
+ * @throws Exception If the extended operations cannot be loaded
*/
private void loadExtendedOperation( String extendedOperationFQCN ) throws Exception
{
@@ -408,6 +426,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads a list of intermediate responses from their FQCN
+ *
+ * @param intermediateResponsesList The list of intermediate response to load
+ * @throws Exception If one of the intermediate response cannot be loaded
*/
private void loadIntermediateResponse( List<String> intermediateResponsesList ) throws Exception
{
@@ -424,6 +445,9 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Loads an intermediate responses from its FQCN
+ *
+ * @param intermediateResponseFQCN The intermediate response to load
+ * @throws Exception If the intermediate response cannot be loaded
*/
private void loadIntermediateResponse( String intermediateResponseFQCN ) throws Exception
{
diff --git a/ldap/extras/aci/src/main/antlr/ACIItem.g b/ldap/extras/aci/src/main/antlr/ACIItem.g
index e256db3..af89f19 100644
--- a/ldap/extras/aci/src/main/antlr/ACIItem.g
+++ b/ldap/extras/aci/src/main/antlr/ACIItem.g
@@ -40,6 +40,7 @@ import org.apache.directory.api.ldap.model.filter.LeafNode;
import org.apache.directory.api.ldap.model.filter.EqualityNode;
import org.apache.directory.api.ldap.model.filter.FilterParser;
import org.apache.directory.api.ldap.model.schema.normalizers.NameComponentNormalizer;
+import org.apache.directory.api.ldap.model.schema.Normalizer;
import org.apache.directory.api.ldap.model.subtree.SubtreeSpecification;
import org.apache.directory.api.ldap.model.subtree.SubtreeSpecificationModifier;
import org.apache.directory.api.util.ComponentsMonitor;
@@ -155,7 +156,7 @@ tokens
* This method MUST be called for each instance while we cannot do
* constructor overloading for this class.
*
- * @return the DnParser to be used for parsing Names
+ * @param schemaManager the SchemaManager
*/
public void init( SchemaManager schemaManager )
{
@@ -164,6 +165,8 @@ tokens
/**
* Sets the NameComponentNormalizer for this parser's dnParser.
+ *
+ * @param normalizer The {@link Normalizer} to use
*/
public void setNormalizer(NameComponentNormalizer normalizer)
{
diff --git a/ldap/extras/aci/src/main/antlr/ACIItemChecker.g b/ldap/extras/aci/src/main/antlr/ACIItemChecker.g
index 085755b..df8fa41 100644
--- a/ldap/extras/aci/src/main/antlr/ACIItemChecker.g
+++ b/ldap/extras/aci/src/main/antlr/ACIItemChecker.g
@@ -25,6 +25,7 @@ package org.apache.directory.api.ldap.aci;
import org.apache.directory.api.ldap.model.schema.normalizers.NameComponentNormalizer;
+import org.apache.directory.api.ldap.model.schema.Normalizer;
}
@@ -73,8 +74,6 @@ tokens
* Creates a (normalizing) subordinate DnParser for parsing Names.
* This method MUST be called for each instance while we cannot do
* constructor overloading for this class.
- *
- * @return the DnParser to be used for parsing Names
*/
public void init()
{
@@ -82,6 +81,8 @@ tokens
/**
* Sets the NameComponentNormalizer for this parser's dnParser.
+ *
+ * @param normalizer The {@link Normalizer} to use
*/
public void setNormalizer(NameComponentNormalizer normalizer)
{
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemChecker.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemChecker.java
index 1b816cb..2487aec 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemChecker.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemChecker.java
@@ -64,6 +64,8 @@ public class ACIItemChecker
/**
* Initializes the plumbing by creating a pipe and coupling the parser/lexer
* pair with it. param spec the specification to be parsed
+ *
+ * @param spec The part to parse
*/
private synchronized void reset( String spec )
{
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemParser.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemParser.java
index 1f0fe95..6b86e29 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemParser.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemParser.java
@@ -92,7 +92,9 @@ public class ACIItemParser
/**
* Initializes the plumbing by creating a pipe and coupling the parser/lexer
- * pair with it. param spec the specification to be parsed
+ * pair with it.
+ *
+ * @param spec the specification to be parsed
*/
private synchronized void reset( String spec )
{
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemChecker.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemChecker.java
index a3cb573..1c38dc8 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemChecker.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemChecker.java
@@ -40,6 +40,8 @@ class ReusableAntlrACIItemChecker extends AntlrACIItemChecker
{
/**
* Creates a ReusableAntlrACIItemChecker instance.
+ *
+ * @param lexer The stream to use for tokens
*/
ReusableAntlrACIItemChecker( TokenStream lexer )
{
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemParser.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemParser.java
index 6a5b389..c3a8492 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemParser.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ReusableAntlrACIItemParser.java
@@ -40,6 +40,8 @@ class ReusableAntlrACIItemParser extends AntlrACIItemParser
{
/**
* Creates a ReusableAntlrSubtreeSpecificationParser instance.
+ *
+ * @param lexer The token stream to process
*/
ReusableAntlrACIItemParser( TokenStream lexer )
{
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
index 62bf4c9..4d5d70c 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
@@ -44,6 +44,8 @@ public enum SyncModifyDnType
/**
* Creates the value
+ *
+ * @param value The MOD DN type
*/
SyncModifyDnType( int value )
{
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncFlag.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncFlag.java
index 3e2604e..54ab2e5 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncFlag.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncFlag.java
@@ -47,7 +47,12 @@ public enum AdDirSyncFlag
/** The string description **/
private String description;
- /** A private constructor that associates a value and description to each flag */
+ /**
+ * A private constructor that associates a value and description to each flag
+ *
+ * @param value The AdDirSync integer value
+ * @param description The AdDirSync description
+ **/
AdDirSyncFlag( int value, String description )
{
this.value = value;
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java
index e4a6595..6a9a9a7 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java
@@ -19,6 +19,7 @@
*/
package org.apache.directory.api.ldap.extras.controls.ppolicy;
+import org.apache.directory.api.ldap.model.message.Control;
/**
* A simple {@link PasswordPolicy} Control implementation.
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
index 7b92207..5d097d3 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
@@ -40,7 +40,7 @@ public interface TransactionSpecification extends Control
/**
* Set the transaction ID
- * @param The transaction identifier, an opaque byte array
+ * @param identifier The transaction identifier, an opaque byte array
*/
void setIdentifier( byte[] identifier );
}
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
index 4b92a89..d3464b7 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
@@ -71,7 +71,7 @@ public interface EndTransactionResponse extends ExtendedResponse
/**
- * @return the list of <messageId, Controls> processed within the transaction
+ * @return the list of <messageId, Controls> processed within the transaction
*/
List<UpdateControls> getUpdateControls();
}
\ No newline at end of file
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
index 7797b24..306436c 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
@@ -66,7 +66,7 @@ public class EndTransactionResponseImpl extends ExtendedResponseImpl implements
* Create a new EndTransactionResponseImpl object
*
* @param failedMessageId The faulty messageId
- * @param rcode the result code
+ * @param resultCode the result code
*/
public EndTransactionResponseImpl( int failedMessageId, ResultCodeEnum resultCode )
{
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
index 002fdaa..405f6a9 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
@@ -53,7 +53,7 @@ public class StartTransactionResponseImpl extends ExtendedResponseImpl implement
* Create a new StartTransactionResponseImpl object
*
* @param messageId The messageId
- * @param rcode the result code
+ * @param resultCode the result code
* @param transactionId The transaction ID
*/
public StartTransactionResponseImpl( int messageId, ResultCodeEnum resultCode, byte[] transactionId )
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java
index 8d26e17..aabe63f 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java
@@ -157,6 +157,8 @@ public class CancelRequestDecorator extends ExtendedRequestDecorator<CancelReque
* |
* +--> 0x02 0x0(1-4) [0..2^31-1]
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java
index 53733f9..4cc0ac1 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java
@@ -232,6 +232,8 @@ public class CertGenerationRequestDecorator extends ExtendedRequestDecorator<Cer
* +--> 0x04 LL subject DN
* +--> 0x04 LL key algorithm
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestDecorator.java
index 6a1cf59..d338127 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestDecorator.java
@@ -154,6 +154,8 @@ public class EndTransactionRequestDecorator extends ExtendedRequestDecorator<End
* +-- 0x01 0x01 commit
* +-- 0x04 L2 identifier]
* </pre>
+ *
+ * @return The extended operation's length
*/
/* No qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseDecorator.java
index 692b6d2..8fa8ecd 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseDecorator.java
@@ -169,9 +169,11 @@ public class EndTransactionResponseDecorator extends ExtendedResponseDecorator<E
* +-- 0x30 L4 updateControls SEQUENCE
* |
* +-- 0x02 L5 messageID
- * +-- <controls>]
+ * +-- <controls>]
*
* </pre>
+ *
+ * @return The extended operation's length
*/
/* No qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java
index e7064c6..7888116 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java
@@ -197,12 +197,14 @@ public class GracefulDisconnectResponseDecorator extends ExtendedResponseDecorat
* <pre>
* 0x30 L1
* |
- * +--> [ 0x02 0x0(1-4) [0..720] ]
- * +--> [ 0x80 0x0(1-3) [0..86400] ]
- * +--> [ 0x30 L2
+ * +--> [ 0x02 0x0(1-4) [0..720] ]
+ * +--> [ 0x80 0x0(1-3) [0..86400] ]
+ * +--> [ 0x30 L2
* |
- * +--> (0x04 L3 value) + ]
+ * +--> (0x04 L3 value) + ]
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */ int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java
index 284d176..7f170aa 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java
@@ -168,6 +168,8 @@ public class GracefulShutdownRequestDecorator extends ExtendedRequestDecorator<G
* +--> [0x80 0x0(1-3) [0..86400] ]
* </pre>
* L1 will always be < 11.
+ *
+ * @return The extended operation's length
*/
/* no qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestDecorator.java
index 11bc78a..7add696 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestDecorator.java
@@ -187,6 +187,8 @@ public class PasswordModifyRequestDecorator extends ExtendedRequestDecorator<Pas
* [+-- 0x81 L3 oldPassword]
* [+-- 0x82 L4 newPassword]
* </pre>
+ *
+ * @return The extended operation's length
*/
/* No qualifier */int computeLengthInternal()
{
@@ -218,7 +220,6 @@ public class PasswordModifyRequestDecorator extends ExtendedRequestDecorator<Pas
* Encodes the PasswordModifyRequest extended operation.
*
* @return A ByteBuffer that contains the encoded PDU
- * @throws org.apache.directory.api.asn1.EncoderException If anything goes wrong.
*/
/* No qualifier */ByteBuffer encodeInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java
index a501e35..3a79b29 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java
@@ -146,6 +146,8 @@ public class PasswordModifyResponseDecorator extends ExtendedResponseDecorator<P
* |
* [+-- 0x80 L2 genPassword]
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */int computeLengthInternal()
{
@@ -165,7 +167,6 @@ public class PasswordModifyResponseDecorator extends ExtendedResponseDecorator<P
* Encodes the PasswordModifyResponse extended operation.
*
* @return A ByteBuffer that contains the encoded PDU
- * @throws org.apache.directory.api.asn1.EncoderException If anything goes wrong.
*/
/* no qualifier */ByteBuffer encodeInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java
index 819e3d5..38b2269 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java
@@ -134,6 +134,8 @@ public class StoredProcedureRequestDecorator extends ExtendedRequestDecorator<St
* +--> 0x04 L6-m type
* +--> 0x04 L7-m value
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */ int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java
index 27949a5..4b0de3e 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java
@@ -133,6 +133,8 @@ public class WhoAmIResponseDecorator extends ExtendedResponseDecorator<WhoAmIRes
/**
* Set the userId
+ *
+ * @param userId The USer ID to set
*/
/* no qualifier*/void setUserId( String userId )
{
@@ -141,7 +143,9 @@ public class WhoAmIResponseDecorator extends ExtendedResponseDecorator<WhoAmIRes
/**
- * Set the DnId
+ * Set the Dn
+ *
+ * @param dn the DN to set
*/
/* no qualifier*/void setDn( Dn dn )
{
@@ -215,6 +219,8 @@ public class WhoAmIResponseDecorator extends ExtendedResponseDecorator<WhoAmIRes
* <pre>
* 0x04 L1 authzId
* </pre>
+ *
+ * @return The extended operation's length
*/
/* no qualifier */int computeLengthInternal()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoFactory.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoFactory.java
index 9f13a0c..94a6ac9 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoFactory.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoFactory.java
@@ -36,7 +36,9 @@ public class SyncInfoFactory implements IntermediateResponseFactory
private LdapApiService codec;
/**
+ * Creates an instance of SyncInfoFactory
*
+ * @param codec The {@link LdapApiService} instance
*/
public SyncInfoFactory( LdapApiService codec )
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
index 37b6c8f..23a4e28 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
@@ -28,7 +28,7 @@ import org.apache.directory.api.ldap.model.message.IntermediateResponse;
/**
- * A {@link IntermediateResponselFactory} which creates {@link SyncInfoValue} instances.
+ * A {@link IntermediateResponseFactory} which creates {@link SyncInfoValue} instances.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
index b7f7833..1ee7278 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
@@ -56,7 +56,7 @@ public abstract class SimpleNode<T> extends LeafNode
* Creates a new SimpleNode object.
*
* @param attribute the attribute name
- * @param value the value to test for
+ * @param bytes the data to inject
* @param assertionType the type of assertion represented by this ExprNode
*/
protected SimpleNode( String attribute, byte[] bytes, AssertionType assertionType )
@@ -69,8 +69,8 @@ public abstract class SimpleNode<T> extends LeafNode
/**
* Creates a new SimpleNode object.
*
- * @param attribute the attribute name
- * @param value the value to test for
+ * @param attributeType the attribute name
+ * @param bytes the data to inject
* @param assertionType the type of assertion represented by this ExprNode
*/
protected SimpleNode( AttributeType attributeType, byte[] bytes, AssertionType assertionType )
@@ -100,7 +100,7 @@ public abstract class SimpleNode<T> extends LeafNode
* Creates a new SimpleNode object.
*
* @param attribute the attribute name
- * @param value the value to test for
+ * @param string the value to inject
* @param assertionType the type of assertion represented by this ExprNode
*/
protected SimpleNode( String attribute, String string, AssertionType assertionType )
@@ -132,7 +132,7 @@ public abstract class SimpleNode<T> extends LeafNode
/**
* Creates a new SimpleNode object.
*
- * @param attribute the attribute name
+ * @param attributeType the attribute name
* @param value the value to test for
* @param assertionType the type of assertion represented by this ExprNode
*/
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java
index 7b00e4d..872fab0 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java
@@ -950,10 +950,9 @@ public class LdifEntry implements Cloneable, Externalizable, Iterable<Attribute>
/**
- * @param lengthBeforeParsing the lengthBeforeParsing to set
+ * @param length the lengthBeforeParsing to set
*/
- /**No qualifier*/
- void setLengthBeforeParsing( int length )
+ /*No qualifier*/ void setLengthBeforeParsing( int length )
{
this.lengthBeforeParsing = length;
}
@@ -971,8 +970,7 @@ public class LdifEntry implements Cloneable, Externalizable, Iterable<Attribute>
/**
* @param offset the offset to set
*/
- /**No qualifier*/
- void setOffset( long offset )
+ /*No qualifier*/ void setOffset( long offset )
{
this.offset = offset;
}
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java
index f077648..720765a 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java
@@ -378,7 +378,10 @@ public class LdifReader implements Iterable<LdifEntry>, Closeable
/**
- * Store the reader and intialize the LdifReader
+ * Store the reader and initialize the LdifReader
+ *
+ * @param reader The reader to use
+ * @throws LdapException If the initialization failed
*/
private void initReader( BufferedReader reader ) throws LdapException
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java
index 60530fe..dd9ab9a 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java
@@ -225,7 +225,6 @@ public final class LdifUtils
*
* @param entry the Entry to convert
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertToLdif( Entry entry )
{
@@ -239,7 +238,6 @@ public final class LdifUtils
* @param entry the Entry to convert
* @param includeVersionInfo flag to tell whether to include version number or not
* @return the corresponding LDIF code as a String
- * @throws org.apache.directory.api.ldap.model.exception.LdapException If a naming exception is encountered.
*/
public static String convertToLdif( Entry entry, boolean includeVersionInfo )
{
@@ -259,7 +257,6 @@ public final class LdifUtils
*
* @param entry the Entry to convert
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertAttributesToLdif( Entry entry )
{
@@ -293,7 +290,6 @@ public final class LdifUtils
* @param entry the Entry to convert
* @param length the expected line length
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertToLdif( Entry entry, int length )
{
@@ -330,7 +326,6 @@ public final class LdifUtils
* @param entry the Entry to convert
* @param length the expected line length
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertAttributesToLdif( Entry entry, int length )
{
@@ -548,7 +543,6 @@ public final class LdifUtils
*
* @param attr the EntryAttribute to convert
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertToLdif( Attribute attr )
{
@@ -562,7 +556,6 @@ public final class LdifUtils
* @param attr the EntryAttribute to convert
* @param length the expected line length
* @return the corresponding LDIF code as a String
- * @throws LdapException If a naming exception is encountered.
*/
public static String convertToLdif( Attribute attr, int length )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java
index c70628b..bac2396 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java
@@ -89,7 +89,7 @@ public interface PersistentSearch extends Control
* For each changeType, tells if the notification is enabled
*
* @param changeType The ChnageType we are interested in
- * @return <tt>TRUE<tt> if the notification is set for this ChangeType
+ * @return <tt>TRUE</tt> if the notification is set for this ChangeType
*/
boolean isNotificationEnabled( ChangeType changeType );
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/AddNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/AddNoDResponse.java
index b45743e..a0cd2d4 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/AddNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/AddNoDResponse.java
@@ -49,6 +49,8 @@ public final class AddNoDResponse extends AddResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private AddNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/BindNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/BindNoDResponse.java
index a55e7ce..e9f4647 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/BindNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/BindNoDResponse.java
@@ -49,6 +49,8 @@ public final class BindNoDResponse extends BindResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private BindNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/CompareNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/CompareNoDResponse.java
index 55c0d2a..dbe34ef 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/CompareNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/CompareNoDResponse.java
@@ -49,6 +49,8 @@ public final class CompareNoDResponse extends CompareResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private CompareNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/DeleteNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/DeleteNoDResponse.java
index 70f13c5..506f31a 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/DeleteNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/DeleteNoDResponse.java
@@ -49,6 +49,8 @@ public final class DeleteNoDResponse extends DeleteResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private DeleteNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ExtendedNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ExtendedNoDResponse.java
index b3abd50..2c3f467 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ExtendedNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ExtendedNoDResponse.java
@@ -52,6 +52,8 @@ public final class ExtendedNoDResponse extends ExtendedResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private ExtendedNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyDnNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyDnNoDResponse.java
index 6fd5108..2322c60 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyDnNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyDnNoDResponse.java
@@ -49,6 +49,8 @@ public final class ModifyDnNoDResponse extends ModifyDnResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private ModifyDnNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyNoDResponse.java
index e82f410..f82d5e1 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/ModifyNoDResponse.java
@@ -49,6 +49,8 @@ public final class ModifyNoDResponse extends ModifyResponseImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private ModifyNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/SearchNoDResponse.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/SearchNoDResponse.java
index 94d1cbf..bb5e3af 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/SearchNoDResponse.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/extended/SearchNoDResponse.java
@@ -49,6 +49,8 @@ public final class SearchNoDResponse extends SearchResultDoneImpl
/**
* Creates a new instance of NoticeOfDisconnect.
+ *
+ * @param rcode The {@link ResultCodeEnum} value to wrap
*/
private SearchNoDResponse( ResultCodeEnum rcode )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java
index c3c52e1..f106cf9 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java
@@ -416,8 +416,10 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
/**
* Construct an Ava. The type and value are normalized :
- * <li> the type is trimmed and lowercased </li>
- * <li> the value is trimmed </li>
+ * <ul>
+ * <li> the type is trimmed and lowercased </li>
+ * <li> the value is trimmed </li>
+ * </ul>
* <p>
* Note that the upValue should <b>not</b> be null or empty, or resolved
* to an empty string after having trimmed it.
@@ -441,8 +443,10 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
/**
* Construct an Ava. The type and value are normalized :
- * <li> the type is trimmed and lowercased </li>
- * <li> the value is trimmed </li>
+ * <ul>
+ * <li> the type is trimmed and lowercased </li>
+ * <li> the value is trimmed </li>
+ * </ul>
* <p>
* Note that the upValue should <b>not</b> be null or empty, or resolved
* to an empty string after having trimmed it.
@@ -500,8 +504,10 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
/**
* Construct an Ava. The type and value are normalized :
- * <li> the type is trimmed and lowercased </li>
- * <li> the value is trimmed </li>
+ * <ul>
+ * <li> the type is trimmed and lowercased </li>
+ * <li> the value is trimmed </li>
+ * </ul>
* <p>
* Note that the upValue should <b>not</b> be null or empty, or resolved
* to an empty string after having trimmed it.
@@ -554,8 +560,6 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
* @param schemaManager The SchemaManager instance
* @param upType The User Provided type
* @param value The value
- *
- * @throws LdapInvalidDnException If the given type or value are invalid
*/
private void createAva( SchemaManager schemaManager, String upType, Value value )
{
@@ -581,8 +585,10 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
/**
* Construct an Ava. The type and value are normalized :
- * <li> the type is trimmed and lowercased </li>
- * <li> the value is trimmed </li>
+ * <ul>
+ * <li> the type is trimmed and lowercased </li>
+ * <li> the value is trimmed </li>
+ * </ul>
* <p>
* Note that the upValue should <b>not</b> be null or empty, or resolved
* to an empty string after having trimmed it.
@@ -635,7 +641,7 @@ public class Ava implements Externalizable, Cloneable, Comparable<Ava>
/**
- * Apply a SchemaManager to the Ava. It will normalize the Ava.<br/>
+ * Apply a SchemaManager to the Ava. It will normalize the Ava.<br>
* If the Ava already had a SchemaManager, then the new SchemaManager will be
* used instead.
*
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/BCrypt.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/BCrypt.java
index 1081d5e..145252b 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/BCrypt.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/BCrypt.java
@@ -696,9 +696,10 @@ public class BCrypt
/**
* Perform the central password hashing step in the
* bcrypt scheme
+ *
* @param password the password to hash
* @param salt the binary salt to hash with the password
- * @param log_rounds the binary logarithm of the number
+ * @param logRounds the binary logarithm of the number
* of rounds of hashing to apply
* @param cdata the plaintext to encrypt
* @return an array containing the binary hashed password
@@ -842,7 +843,8 @@ public class BCrypt
/**
* Generate a salt for use with the BCrypt.hashpw() method
- * @param log_rounds the log2 of the number of rounds of
+ *
+ * @param logRounds the log2 of the number of rounds of
* hashing to apply - the work factor therefore increases as
* 2**log_rounds.
* @param random an instance of SecureRandom to use
@@ -876,10 +878,11 @@ public class BCrypt
/**
* Generate a salt for use with the BCrypt.hashpw() method
- * @param log_rounds the log2 of the number of rounds of
+ *
+ * @param logRounds the log2 of the number of rounds of
* hashing to apply - the work factor therefore increases as
* 2**log_rounds.
- * @return an encoded salt value
+ * @return an encoded salt value
*/
public static String gensalt( int logRounds )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/ObjectClassTypeEnum.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/ObjectClassTypeEnum.java
index 12a7160..1ce6ce2 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/ObjectClassTypeEnum.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/ObjectClassTypeEnum.java
@@ -62,10 +62,7 @@ public enum ObjectClassTypeEnum
* Private constructor so no other instances can be created other than the
* public static constants in this class.
*
- * @param name
- * a string name for the enumeration value.
- * @param value
- * the integer value of the enumeration.
+ * @param value the integer value of the enumeration.
*/
ObjectClassTypeEnum( int value )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
index 7f1cd3e..da355b7 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
@@ -3351,7 +3351,6 @@ public final class PrepareString
*
* @param origin The String to modify
* @return The modified String
- * @throws InvalidCharacterException If an invalid character is met
*/
public static String insignificantSpacesStringValue( char[] origin )
{
@@ -3576,7 +3575,6 @@ public final class PrepareString
*
* @param origin The String to modify
* @return The modified String
- * @throws InvalidCharacterException If an invalid character is met
*/
public static String insignificantSpacesStringInitial( char[] origin )
{
@@ -3800,7 +3798,6 @@ public final class PrepareString
*
* @param origin The String to modify
* @return The modified String
- * @throws InvalidCharacterException If an invalid character is met
*/
public static String insignificantSpacesStringAny( char[] origin )
{
@@ -4014,7 +4011,6 @@ public final class PrepareString
*
* @param origin The String to modify
* @return The modified StringBuilder
- * @throws InvalidCharacterException If an invalid character is found in the String
*/
public static String insignificantSpacesStringFinal( char[] origin )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java
index af8491b..91fcf9d 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectRenderer.java
@@ -706,7 +706,8 @@ public final class SchemaObjectRenderer
* oidlist ::= oid ( WSP '$' WSP oid )*
* </pre>
*
- * @param qdescrs the quoted description strings to render
+ * @param buf The resulting buffer
+ * @param oids the list of OIDs to render
* @return the string buffer the qdescrs are rendered into
*/
private StringBuilder renderOids( StringBuilder buf, List<String> oids )
@@ -745,7 +746,8 @@ public final class SchemaObjectRenderer
/**
* Renders QDString into a new buffer.<br>
*
- * @param qdescrs the quoted description strings to render
+ * @param buf The resulting buffer
+ * @param qdString the quoted description strings to render
* @return the string buffer the qdescrs are rendered into
*/
private StringBuilder renderQDString( StringBuilder buf, String qdString )
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java
index ebf25d8..c668cda 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaUtils.java
@@ -134,10 +134,8 @@ public final class SchemaUtils
/**
* Renders qdescrs into an existing buffer.
*
- * @param buf
- * the string buffer to render the quoted description strs into
- * @param qdescrs
- * the quoted description strings to render
+ * @param buf the string buffer to render the quoted description strs into
+ * @param qdescrs the quoted description strings to render
* @return the same string buffer that was given for call chaining
*/
public static StringBuilder render( StringBuilder buf, List<String> qdescrs )
@@ -173,6 +171,8 @@ public final class SchemaUtils
* qdescrlist ::= [ qdescr ( SP qdescr )* ]
* qdescr ::= SQUOTE descr SQUOTE
* </pre>
+ *
+ * @param buf the string buffer to render the quoted description strings into
* @param qdescrs the quoted description strings to render
* @return the string buffer the qdescrs are rendered into
*/
@@ -206,7 +206,8 @@ public final class SchemaUtils
/**
* Renders QDString into a new buffer.<br>
*
- * @param qdescrs the quoted description strings to render
+ * @param buf the string buffer to render the quoted description string into
+ * @param qdString the quoted description strings to render
* @return the string buffer the qdescrs are rendered into
*/
private static StringBuilder renderQDString( StringBuilder buf, String qdString )
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
index f6ddb4c..1531816 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
@@ -465,8 +465,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* <li>8) NameForms (depends on ObjectClasses and AttributeTypes)</li>
* <li>9) DitStructureRules (depends onNameForms and DitStructureRules)</li>
* </ul>
- *
- * @return a list of exceptions encountered while resolving entities
*/
public void checkRefInteg()
{
@@ -653,7 +651,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Build the SchemaObject references
*
- * @param errors The List that collect errors
* @param schemaObject The SchemaObject to add
*/
public void buildReference( SchemaObject schemaObject )
@@ -719,7 +716,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Unlink the SchemaObject references
*
- * @param errors The List that collect errors
* @param schemaObject The SchemaObject to remove
*/
public void removeReference( SchemaObject schemaObject )
@@ -878,8 +874,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Build the usedBy and using references from the stored elements.
- *
- * @return A list of all the errors we met during the cross reference update
*/
public void buildReferences()
{
@@ -922,7 +916,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* Attempts to resolve the SyntaxChecker associated with a Syntax.
*
* @param syntax the LdapSyntax to resolve the SyntaxChecker of
- * @param errors the list of errors to add exceptions to
*/
private void resolve( LdapSyntax syntax )
{
@@ -943,7 +936,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* Attempts to resolve the Normalizer
*
* @param normalizer the Normalizer
- * @param errors the list of errors to add exceptions to
*/
private void resolve( Normalizer normalizer )
{
@@ -955,7 +947,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* Attempts to resolve the LdapComparator
*
* @param comparator the LdapComparator
- * @param errors the list of errors to add exceptions to
*/
private void resolve( LdapComparator<?> comparator )
{
@@ -966,8 +957,7 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Attempts to resolve the SyntaxChecker
*
- * @param normalizer the SyntaxChecker
- * @param errors the list of errors to add exceptions to
+ * @param syntaxChecker the SyntaxChecker
*/
private void resolve( SyntaxChecker syntaxChecker )
{
@@ -978,6 +968,8 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Check if the Comparator, Normalizer and the syntax are
* existing for a matchingRule.
+ *
+ * @param matchingRule The matching rule to use
*/
private void resolve( MatchingRule matchingRule )
{
@@ -1336,7 +1328,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Applies the added SchemaObject to the given register
*
- * @param errors The list of collected errors
* @param schemaObject The SchemaObject to add
* @param check A flag set when we want the schema checks to be done
* @throws LdapException If we weren't able to add the SchemaObject
@@ -1379,9 +1370,7 @@ public class Registries implements SchemaLoaderListener, Cloneable
/**
* Remove the given SchemaObject from the registries
*
- * @param errors The list of collected errors
* @param schemaObject The SchemaObject to delete
- * @return The list of errors
* @throws LdapException If the deletion failed
*/
public void delete( SchemaObject schemaObject ) throws LdapException
@@ -1602,7 +1591,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* Store the given SchemaObject in the Map associating SchemaObjetcs to their
* related Schema.
*
- * @param errors The list of errors we are accumulating while checking the schema
* @param schemaObject The schemaObject to register
*/
public void associateWithSchema( SchemaObject schemaObject )
@@ -1675,7 +1663,6 @@ public class Registries implements SchemaLoaderListener, Cloneable
* Store the given SchemaObject in the Map associating SchemaObjetcs to their
* related Schema.
*
- * @param errors The list that collect errors
* @param schemaObject The schemaObject to register
* @throws LdapException If there is a problem
*/
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java
index db2eaa4..81e10cf 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/DitStructureRuleHelper.java
@@ -20,7 +20,6 @@
package org.apache.directory.api.ldap.model.schema.registries.helper;
-import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.schema.DitStructureRule;
import org.apache.directory.api.ldap.model.schema.SchemaErrorHandler;
import org.apache.directory.api.ldap.model.schema.registries.Registries;
@@ -46,7 +45,6 @@ public final class DitStructureRuleHelper
* @param ditStructureRule The DitStructureRule to add to the Registries
* @param errorHandler Error handler
* @param registries The Registries
- * @throws LdapException If the addition failed
*/
public static void addToRegistries( DitStructureRule ditStructureRule, SchemaErrorHandler errorHandler, Registries registries )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java
index ef5dcd4..2789766 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/LdapSyntaxHelper.java
@@ -98,7 +98,6 @@ public final class LdapSyntaxHelper
* @param ldapSyntax The LdapSyntax to remove from the Registries
* @param errorHandler Error handler
* @param registries The Registries
- * @throws LdapException If the LdapSyntax is not valid
*/
public static void removeFromRegistries( LdapSyntax ldapSyntax, SchemaErrorHandler errorHandler, Registries registries )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/MatchingRuleHelper.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/MatchingRuleHelper.java
index d38085a..90ac4fb 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/MatchingRuleHelper.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/MatchingRuleHelper.java
@@ -158,7 +158,6 @@ public final class MatchingRuleHelper
* @param matchingRule The MatchingRule to remove from the Registries
* @param errorHandler Error handler
* @param registries The Registries
- * @throws LdapException If the MatchingRule is not valid
*/
public static void removeFromRegistries( MatchingRule matchingRule, SchemaErrorHandler errorHandler, Registries registries )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/ObjectClassHelper.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/ObjectClassHelper.java
index cda0c2e..c6e1d02 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/ObjectClassHelper.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/helper/ObjectClassHelper.java
@@ -58,7 +58,6 @@ public final class ObjectClassHelper
* @param objectClass The ObjectClass to add to the Registries
* @param errorHandler Error handler
* @param registries The Registries
- * @throws LdapException on failure
*/
public static void addToRegistries( ObjectClass objectClass, SchemaErrorHandler errorHandler, Registries registries )
{
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/AttributeTypeUsageSyntaxChecker.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/AttributeTypeUsageSyntaxChecker.java
index caaa739..f57516e 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/AttributeTypeUsageSyntaxChecker.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/AttributeTypeUsageSyntaxChecker.java
@@ -30,9 +30,9 @@ import org.apache.directory.api.util.Strings;
* A syntax checker which checks to see if an attributeType's type is either:
* <ul>
* <li>userApplications</li>
- * <lidirectoryOperation</li>
- * <lidistributedOperation</li>
- * <lidSAOperation</li>
+ * <li>directoryOperation</li>
+ * <li>distributedOperation</li>
+ * <li>dSAOperation</li>
* </ul>
.*
* The case is NOT ignored.
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DeliveryMethodSyntaxChecker.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DeliveryMethodSyntaxChecker.java
index 5ff16aa..5a1e133 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DeliveryMethodSyntaxChecker.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DeliveryMethodSyntaxChecker.java
@@ -127,7 +127,7 @@ public final class DeliveryMethodSyntaxChecker extends SyntaxChecker
* not already been found.
*
* @param strValue The string we want to look into for a PDM
- * @param pos The current position in the string
+ * @param start The current position in the string
* @param pdms The set containing all the PDM
* @return if a Prefered Delivery Method is found in the given string, returns
* its position, otherwise, returns -1
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DnSyntaxChecker.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DnSyntaxChecker.java
index b5e6735..d24dfe0 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DnSyntaxChecker.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/DnSyntaxChecker.java
@@ -23,6 +23,7 @@ package org.apache.directory.api.ldap.model.schema.syntaxCheckers;
import org.apache.directory.api.i18n.I18n;
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
import org.apache.directory.api.ldap.model.name.Dn;
+import org.apache.directory.api.ldap.model.name.Rdn;
import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
import org.apache.directory.api.util.Strings;
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/JpegSyntaxChecker.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/JpegSyntaxChecker.java
index d6b78de..47538ca 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/JpegSyntaxChecker.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/JpegSyntaxChecker.java
@@ -36,7 +36,7 @@ import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
* 0xNN 0xNN (Header length)
* "JFIF\0" (JFIF string with an ending \0)
* some other bytes which are related to the image.
- * <pre>
+ * </pre>
*
* We will check for those 11 bytes, except the length.
*
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/NameAndOptionalUIDSyntaxChecker.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/NameAndOptionalUIDSyntaxChecker.java
index 7207571..ecbb30f 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/NameAndOptionalUIDSyntaxChecker.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/syntaxCheckers/NameAndOptionalUIDSyntaxChecker.java
@@ -23,6 +23,7 @@ package org.apache.directory.api.ldap.model.schema.syntaxCheckers;
import org.apache.directory.api.i18n.I18n;
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
import org.apache.directory.api.ldap.model.name.Dn;
+import org.apache.directory.api.ldap.model.name.Rdn;
import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
import org.apache.directory.api.util.Strings;
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
index 20e9317..a73703e 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
@@ -1019,7 +1019,6 @@ public class LdapUrl
*
* @param data the string to be encoded
* @return The string as a byte array.
- * @throws org.apache.directory.api.ldap.model.exception.UrlDecoderException if encoding is not supported
*/
private static byte[] getAsciiBytes( final String data )
{
diff --git a/ldap/net/mina/src/main/java/org/apache/directory/api/ldap/codec/protocol/mina/LdapProtocolDecoder.java b/ldap/net/mina/src/main/java/org/apache/directory/api/ldap/codec/protocol/mina/LdapProtocolDecoder.java
index 22a3175..95891d3 100644
--- a/ldap/net/mina/src/main/java/org/apache/directory/api/ldap/codec/protocol/mina/LdapProtocolDecoder.java
+++ b/ldap/net/mina/src/main/java/org/apache/directory/api/ldap/codec/protocol/mina/LdapProtocolDecoder.java
@@ -106,7 +106,7 @@ public class LdapProtocolDecoder implements ProtocolDecoder
* message being decoded. If the message is not fully decoded, the ucrrent state
* is stored into this container
* @param decodedMessages The list of decoded messages
- * @throws Exception If the decoding failed
+ * @throws DecoderException If the decoding failed
*/
private void decode( ByteBuffer buffer, LdapMessageContainer<MessageDecorator<? extends Message>> messageContainer,
List<Message> decodedMessages ) throws DecoderException
diff --git a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
index 5b3f953..679d910 100644
--- a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
+++ b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
@@ -1298,7 +1298,7 @@ public class DefaultSchemaManager implements SchemaManager
*
* @param registries The Registries in which the schemas will be loaded
* @param schema the current schema we are attempting to load
- * @throws Exception if there is a cycle detected and/or another
+ * @throws LdapException if there is a cycle detected and/or another
* failure results while loading, producing and or registering schema objects
*/
private void loadDepsFirst( Registries registries, Schema schema ) throws LdapException
@@ -1405,7 +1405,7 @@ public class DefaultSchemaManager implements SchemaManager
* control with dependency cycle detection.
*
* @param schema the current schema we are attempting to load
- * @throws Exception if there is a cycle detected and/or another
+ * @throws LdapException if there is a cycle detected and/or another
* failure results while loading, producing and or registering schema objects
*/
private void loadDepsFirstRelaxed( Schema schema ) throws LdapException
diff --git a/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java b/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java
index 715ef5b..0993679 100644
--- a/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java
+++ b/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java
@@ -262,6 +262,8 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
* Construct an empty sentinel used to hold the head (sentinel.next) and the
* tail (sentinel.prev) of the list. The sentinel has a <code>null</code>
* key and value.
+ *
+ * @return The created sentinel
*/
private static MapEntry createSentinel()
{
@@ -275,6 +277,8 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
/**
* Removes an internal entry from the linked list. This does not remove it
* from the underlying map.
+ *
+ * @param entry The entry to remove
*/
private void removeEntry( MapEntry entry )
{
@@ -286,6 +290,8 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
/**
* Inserts a new internal entry to the tail of the linked list. This does
* not add the entry to the underlying map.
+ *
+ * @param entry The entry to insert
*/
private void insertEntry( MapEntry entry )
{
@@ -602,6 +608,9 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
/**
* Fully remove an entry from the map, returning the old entry or null if
* there was no such entry with the specified key.
+ *
+ * @param key The key to retreive
+ * @return The removed entry
*/
private MapEntry removeImpl( Object key )
{
@@ -985,6 +994,8 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
* which they were added. The {@link #next()} method returns the type
* specified by <code>returnType</code> which must be either KEY,
* VALUE, or ENTRY.
+ *
+ * @param returnType The type (KEY,VALUE, ENTRY)
*/
OrderedIterator( int returnType )
{
@@ -1134,6 +1145,8 @@ public class SequencedHashMap implements Map, Cloneable, Externalizable
/**
* Returns the Map.Entry at the specified index
*
+ * @param index The index we are looking for
+ * @return The found entry
* @throws ArrayIndexOutOfBoundsException
* if the specified index is <code>< 0</code> or
* <code>></code> the size of the map.