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 2016/09/01 08:05:38 UTC
svn commit: r1758724 - in
/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2:
./ request/ response/
Author: elecharny
Date: Thu Sep 1 08:05:37 2016
New Revision: 1758724
URL: http://svn.apache.org/viewvc?rev=1758724&view=rev
Log:
Updated Javadocs
Modified:
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Tag.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbandonRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractResultResponseRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BindRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/CompareRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/DelRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtendedRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyDNRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResultResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AddResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BatchResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BindResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/CompareResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/DelResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ExtendedResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/LdapResultDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModDNResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModifyResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResponseDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultDoneDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java
directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultReferenceDsml.java
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2Parser.java Thu Sep 1 08:05:37 2016
@@ -97,6 +97,7 @@ public class Dsmlv2Parser
/**
* Creates a new instance of Dsmlv2Parser.
*
+ * @param grammar The grammar in use
* @throws XmlPullParserException if an error occurs during the initialization of the parser
*/
public Dsmlv2Parser( Dsmlv2Grammar grammar ) throws XmlPullParserException
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Dsmlv2ResponseParser.java Thu Sep 1 08:05:37 2016
@@ -55,6 +55,7 @@ public class Dsmlv2ResponseParser
/**
* Creates a new instance of Dsmlv2ResponseParser.
*
+ * @param codec The Ldap Service to use
* @throws XmlPullParserException if an error occurs while the initialization of the parser
*/
public Dsmlv2ResponseParser( LdapApiService codec ) throws XmlPullParserException
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java Thu Sep 1 08:05:37 2016
@@ -224,6 +224,7 @@ public final class ParserUtils
/**
* Adds Controls to the given Element.
*
+ * @param codec The LDAP Service to use
* @param element the element to add the Controls to
* @param controls a List of Controls
*/
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Tag.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Tag.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Tag.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Tag.java Thu Sep 1 08:05:37 2016
@@ -25,7 +25,7 @@ import org.apache.directory.api.util.Str
/**
* This class represents a XML tag.
- * <br/>
+ * <br>
* A XML tag is defined with :
* <ul>
* <li>a name</li>
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbandonRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbandonRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbandonRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbandonRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -38,6 +38,8 @@ public class AbandonRequestDsml extends
{
/**
* Creates a new instance of AbandonRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public AbandonRequestDsml( LdapApiService codec )
{
@@ -48,6 +50,7 @@ public class AbandonRequestDsml extends
/**
* Creates a new instance of AbandonRequestDsml.
*
+ * @param codec The LDAP Service to use
* @param ldapMessage the message to decorate
*/
public AbandonRequestDsml( LdapApiService codec, AbandonRequest ldapMessage )
@@ -97,6 +100,7 @@ public class AbandonRequestDsml extends
* Set the abandoned message ID
*
* @param abandonedMessageId The abandoned messageID to set.
+ * @return The modified AbandonRequest instance
*/
public AbandonRequest setAbandonedMessageId( int abandonedMessageId )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -42,8 +42,8 @@ public abstract class AbstractRequestDsm
/**
* Creates a new instance of AbstractRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public AbstractRequestDsml( LdapApiService codec, E ldapMessage )
{
@@ -54,10 +54,8 @@ public abstract class AbstractRequestDsm
/**
* Creates the Request Element and adds RequestID and Controls.
*
- * @param root
- * the root element
- * @return
- * the Request Element of the given name containing
+ * @param root the root element
+ * @return the Request Element of the given name containing
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractResultResponseRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractResultResponseRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractResultResponseRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AbstractResultResponseRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -44,8 +44,8 @@ public abstract class AbstractResultResp
/**
* Creates a new instance of AbstractRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public AbstractResultResponseRequestDsml( LdapApiService codec, E ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -54,6 +54,8 @@ public class AddRequestDsml
/**
* Creates a new getDecoratedMessage() of AddRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public AddRequestDsml( LdapApiService codec )
{
@@ -64,8 +66,8 @@ public class AddRequestDsml
/**
* Creates a new getDecoratedMessage() of AddRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public AddRequestDsml( LdapApiService codec, AddRequest ldapMessage )
{
@@ -77,6 +79,7 @@ public class AddRequestDsml
* Create a new attributeValue
*
* @param type The attribute's name (called 'type' in the grammar)
+ * @throws LdapException If we can't add the type
*/
public void addAttributeType( String type ) throws LdapException
{
@@ -106,6 +109,7 @@ public class AddRequestDsml
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If we can't add a new value
*/
public void addAttributeValue( String value ) throws LdapException
{
@@ -117,6 +121,7 @@ public class AddRequestDsml
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If we can't add a new value
*/
public void addAttributeValue( Value<?> value ) throws LdapException
{
@@ -128,6 +133,7 @@ public class AddRequestDsml
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If we can't add a new value
*/
public void addAttributeValue( byte[] value ) throws LdapException
{
@@ -215,6 +221,7 @@ public class AddRequestDsml
* Add a new value to the current attribute
*
* @param value The value to be added
+ * @throws LdapException If we can't add a new value
*/
public void addAttributeValue( Object value ) throws LdapException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java Thu Sep 1 08:05:37 2016
@@ -57,6 +57,7 @@ public class AttributeValueAssertion
*
* Helper method to render an object which can be a String or a byte[]
*
+ * @param object The Value to dump
* @return A string representing the object
*/
public static String dumpObject( Object object )
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -328,7 +328,7 @@ public class BatchRequestDsml
* Note: it is better to set this flag to false while processing large DSML
* batch requests
*
- * @param storeReq
+ * @param storeReq Tells if the request objects must be stored or not
*/
public void setStoreReq( boolean storeReq )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BindRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BindRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BindRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BindRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class BindRequestDsml
{
/**
* Creates a new getDecoratedMessage() of AuthRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public BindRequestDsml( LdapApiService codec )
{
@@ -51,6 +53,7 @@ public class BindRequestDsml
/**
* Creates a new getDecoratedMessage() of AuthRequestDsml.
*
+ * @param codec The LDAP Service to use
* @param ldapMessage the message to decorate
*/
public BindRequestDsml( LdapApiService codec, BindRequest ldapMessage )
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/CompareRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/CompareRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/CompareRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/CompareRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -42,6 +42,8 @@ public class CompareRequestDsml
{
/**
* Creates a new getDecoratedMessage() of CompareRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public CompareRequestDsml( LdapApiService codec )
{
@@ -52,8 +54,8 @@ public class CompareRequestDsml
/**
* Creates a new getDecoratedMessage() of CompareRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public CompareRequestDsml( LdapApiService codec, CompareRequest ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java Thu Sep 1 08:05:37 2016
@@ -42,6 +42,7 @@ public abstract class ConnectorFilter ex
* Add a new Filter to the list.
*
* @param filter The filter to add
+ * @throws DecoderException If the added filter is invalid
*/
public void addFilter( Filter filter ) throws DecoderException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/DelRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/DelRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/DelRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/DelRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class DelRequestDsml
{
/**
* Creates a new getDecoratedMessage() of DelRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public DelRequestDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class DelRequestDsml
/**
* Creates a new getDecoratedMessage() of DelRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public DelRequestDsml( LdapApiService codec, DeleteRequest ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtendedRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtendedRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtendedRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtendedRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -47,8 +47,8 @@ public class ExtendedRequestDsml<Q exten
/**
* Creates a new getDecoratedMessage() of ExtendedRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ExtendedRequestDsml( LdapApiService codec, Q ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyDNRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyDNRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyDNRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyDNRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -42,6 +42,8 @@ public class ModifyDNRequestDsml
{
/**
* Creates a new getDecoratedMessage() of ModifyDNRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public ModifyDNRequestDsml( LdapApiService codec )
{
@@ -52,8 +54,8 @@ public class ModifyDNRequestDsml
/**
* Creates a new getDecoratedMessage() of ModifyDNRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ModifyDNRequestDsml( LdapApiService codec, ModifyDnRequest ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -61,6 +61,8 @@ public class ModifyRequestDsml
/**
* Creates a new getDecoratedMessage() of ModifyRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public ModifyRequestDsml( LdapApiService codec )
{
@@ -71,8 +73,8 @@ public class ModifyRequestDsml
/**
* Creates a new getDecoratedMessage() of ModifyRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ModifyRequestDsml( LdapApiService codec, ModifyRequest ldapMessage )
{
@@ -81,7 +83,7 @@ public class ModifyRequestDsml
/**
- * Return the current attribute's type
+ * @return the current attribute's type
*/
public String getCurrentAttributeType()
{
@@ -118,6 +120,7 @@ public class ModifyRequestDsml
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If we can't add a value
*/
public void addAttributeValue( byte[] value ) throws LdapException
{
@@ -129,6 +132,7 @@ public class ModifyRequestDsml
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If we can't add a value
*/
public void addAttributeValue( String value ) throws LdapException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java Thu Sep 1 08:05:37 2016
@@ -63,6 +63,7 @@ public class NotFilter extends Connector
* Set the NotFilter
*
* @param notFilter The notFilter to set.
+ * @throws DecoderException If the filter is invalid
*/
public void setNotFilter( Filter notFilter ) throws DecoderException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SearchRequestDsml.java Thu Sep 1 08:05:37 2016
@@ -82,6 +82,8 @@ public class SearchRequestDsml
/**
* Creates a new getDecoratedMessage() of SearchRequestDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public SearchRequestDsml( LdapApiService codec )
{
@@ -92,8 +94,8 @@ public class SearchRequestDsml
/**
* Creates a new getDecoratedMessage() of SearchRequestDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public SearchRequestDsml( LdapApiService codec, SearchRequest ldapMessage )
{
@@ -156,15 +158,17 @@ public class SearchRequestDsml
/**
* Add a current filter. We have two cases :
- * - there is no previous current filter : the filter
- * is the top level filter
- * - there is a previous current filter : the filter is added
- * to the currentFilter set, and the current filter is changed
- *
+ * <ul>
+ * <li>there is no previous current filter : the filter
+ * is the top level filter</li>
+ * <li>there is a previous current filter : the filter is added
+ * to the currentFilter set, and the current filter is changed</li>
+ * </ul>
* In any case, the previous current filter will always be a
* ConnectorFilter when this method is called.
*
* @param localFilter The filter to set.
+ * @throws DecoderException If the added filter is invalid
*/
public void addCurrentFilter( Filter localFilter ) throws DecoderException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -36,6 +36,7 @@ public abstract class AbstractResponseDs
/**
* Instantiates a new abstract DSML response.
*
+ * @param codec the Ldap Service to use
* @param response the LDAP response message to decorate
*/
public AbstractResponseDsml( LdapApiService codec, E response )
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResultResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResultResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResultResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AbstractResultResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -37,7 +37,8 @@ public abstract class AbstractResultResp
/**
* Instantiates a new abstract DSML response.
*
- * @param ldapMessage the LDAP message to decorate
+ * @param codec The LDAP Service to use
+ * @param resultResponse the LDAP message to decorate
*/
public AbstractResultResponseDsml( LdapApiService codec, E resultResponse )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AddResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AddResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AddResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/AddResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class AddResponseDsml extends Abs
/**
* Creates a new getDecoratedMessage() of AddResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public AddResponseDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class AddResponseDsml extends Abs
/**
* Creates a new getDecoratedMessage() of AddResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public AddResponseDsml( LdapApiService codec, AddResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BatchResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BatchResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BatchResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BatchResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -57,8 +57,7 @@ public class BatchResponseDsml
/**
* Gets the current response
*
- * @return
- * the current response
+ * @return the current response
*/
public DsmlDecorator<? extends Response> getCurrentResponse()
{
@@ -69,10 +68,8 @@ public class BatchResponseDsml
/**
* Adds a request to the Batch Response DSML.
*
- * @param response
- * the request to add
- * @return
- * true (as per the general contract of the Collection.add method).
+ * @param response the request to add
+ * @return true (as per the general contract of the Collection.add method).
*/
public boolean addResponse( DsmlDecorator<? extends Response> response )
{
@@ -83,10 +80,8 @@ public class BatchResponseDsml
/**
* Removes a request from the Batch Response DSML.
*
- * @param response
- * the request to remove
- * @return
- * true if this list contained the specified element.
+ * @param response the request to remove
+ * @return true if this list contained the specified element.
*/
public boolean removeResponse( DsmlDecorator<Response> response )
{
@@ -96,8 +91,8 @@ public class BatchResponseDsml
/**
* Gets the ID of the response
- * @return
- * the ID of the response
+ *
+ * @return the ID of the response
*/
public int getRequestID()
{
@@ -133,8 +128,6 @@ public class BatchResponseDsml
* Converts this Batch Response to its XML representation in the DSMLv2 format.
* The XML document will be formatted for pretty printing by default.
*
- * @see {@link #toDsml(boolean)}
- *
* @return the XML representation in DSMLv2 format
*/
public String toDsml()
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BindResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BindResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BindResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/BindResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -35,6 +35,8 @@ public class BindResponseDsml extends Ab
{
/**
* Creates a new getDecoratedMessage() of AuthResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public BindResponseDsml( LdapApiService codec )
{
@@ -45,8 +47,8 @@ public class BindResponseDsml extends Ab
/**
* Creates a new getDecoratedMessage() of AuthResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public BindResponseDsml( LdapApiService codec, BindResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/CompareResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/CompareResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/CompareResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/CompareResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class CompareResponseDsml extends
/**
* Creates a new getDecoratedMessage() of CompareResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public CompareResponseDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class CompareResponseDsml extends
/**
* Creates a new getDecoratedMessage() of CompareResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public CompareResponseDsml( LdapApiService codec, CompareResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/DelResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/DelResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/DelResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/DelResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -42,6 +42,8 @@ public class DelResponseDsml extends Abs
/**
* Creates a new getDecoratedMessage() of DelResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public DelResponseDsml( LdapApiService codec )
{
@@ -52,8 +54,8 @@ public class DelResponseDsml extends Abs
/**
* Creates a new getDecoratedMessage() of DelResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public DelResponseDsml( LdapApiService codec, DeleteResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java Thu Sep 1 08:05:37 2016
@@ -31,7 +31,7 @@ import org.dom4j.tree.DefaultElement;
/**
* Class representing Error Response.
- * <br/>
+ * <br>
* An Error Response has a requestID, a message, and a type which can be :
* <ul>
* <li>NOT_ATTEMPTED,</li>
@@ -44,7 +44,7 @@ import org.dom4j.tree.DefaultElement;
* <li>OTHER</li>
* </ul>
*
- * @TODO review this class - maybe it should not be decorated and if it is
+ * TODO review this class - maybe it should not be decorated and if it is
* it should extend AbstractResultResponseDsml - by Alex
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ExtendedResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ExtendedResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ExtendedResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ExtendedResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -47,6 +47,8 @@ public class ExtendedResponseDsml extend
/**
* Creates a new getDecoratedMessage() of ExtendedResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public ExtendedResponseDsml( LdapApiService codec )
{
@@ -57,8 +59,8 @@ public class ExtendedResponseDsml extend
/**
* Creates a new getDecoratedMessage() of ExtendedResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ExtendedResponseDsml( LdapApiService codec, ExtendedResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/LdapResultDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/LdapResultDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/LdapResultDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/LdapResultDsml.java Thu Sep 1 08:05:37 2016
@@ -55,11 +55,9 @@ public class LdapResultDsml implements D
/**
* Creates a new instance of LdapResultDsml.
*
- * @param result
- * the LdapResult to decorate
- * @param message
- * the associated message
- * @param the ldap codec service
+ * @param codec The LDAP Service to use
+ * @param result the LdapResult to decorate
+ * @param message the associated message
*/
public LdapResultDsml( LdapApiService codec, LdapResult result, Message message )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModDNResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModDNResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModDNResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModDNResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class ModDNResponseDsml extends A
/**
* Creates a new getDecoratedMessage() of ModDNResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public ModDNResponseDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class ModDNResponseDsml extends A
/**
* Creates a new getDecoratedMessage() of ModDNResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ModDNResponseDsml( LdapApiService codec, ModifyDnResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModifyResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModifyResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModifyResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ModifyResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class ModifyResponseDsml extends
/**
* Creates a new getDecoratedMessage() of ModifyResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public ModifyResponseDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class ModifyResponseDsml extends
/**
* Creates a new getDecoratedMessage() of ModifyResponseDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public ModifyResponseDsml( LdapApiService codec, ModifyResponse ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResponseDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResponseDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResponseDsml.java Thu Sep 1 08:05:37 2016
@@ -52,6 +52,8 @@ public class SearchResponseDsml extends
/**
* Creates a new getDecoratedMessage() of SearchResponseDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public SearchResponseDsml( LdapApiService codec )
{
@@ -62,6 +64,7 @@ public class SearchResponseDsml extends
/**
* Creates a new getDecoratedMessage() of SearchResponseDsml.
*
+ * @param codec The LDAP Service to use
* @param response the LDAP response message to decorate
*/
public SearchResponseDsml( LdapApiService codec, Message response )
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultDoneDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultDoneDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultDoneDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultDoneDsml.java Thu Sep 1 08:05:37 2016
@@ -41,6 +41,8 @@ public class SearchResultDoneDsml extend
/**
* Creates a new getDecoratedMessage() of SearchResultDoneDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public SearchResultDoneDsml( LdapApiService codec )
{
@@ -51,8 +53,8 @@ public class SearchResultDoneDsml extend
/**
* Creates a new getDecoratedMessage() of SearchResultDoneDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public SearchResultDoneDsml( LdapApiService codec, SearchResultDone ldapMessage )
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java Thu Sep 1 08:05:37 2016
@@ -47,7 +47,6 @@ public class SearchResultEntryDsml
extends AbstractResponseDsml<SearchResultEntry>
implements SearchResultEntry
{
-
private static final String SEARCH_RESULT_ENTRY_TAG = "searchResultEntry";
/** The current attribute being processed */
@@ -56,6 +55,8 @@ public class SearchResultEntryDsml
/**
* Creates a new getDecoratedMessage() of SearchResultEntryDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public SearchResultEntryDsml( LdapApiService codec )
{
@@ -66,8 +67,8 @@ public class SearchResultEntryDsml
/**
* Creates a new getDecoratedMessage() of SearchResultEntryDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public SearchResultEntryDsml( LdapApiService codec, SearchResultEntry ldapMessage )
{
@@ -75,6 +76,9 @@ public class SearchResultEntryDsml
}
+ /**
+ * @return The current ATtributeType
+ */
public Attribute getCurrentAttribute()
{
return currentAttribute;
@@ -85,6 +89,7 @@ public class SearchResultEntryDsml
* Create a new attribute
*
* @param type The attribute's type
+ * @throws LdapException If we can't add the new attributeType
*/
public void addAttribute( String type ) throws LdapException
{
@@ -98,6 +103,7 @@ public class SearchResultEntryDsml
* Add a new value to the current attribute
*
* @param value The added value
+ * @throws LdapException If we can't add the new attributeType
*/
public void addAttributeValue( Object value ) throws LdapException
{
Modified: directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultReferenceDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultReferenceDsml.java?rev=1758724&r1=1758723&r2=1758724&view=diff
==============================================================================
--- directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultReferenceDsml.java (original)
+++ directory/shared/trunk/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultReferenceDsml.java Thu Sep 1 08:05:37 2016
@@ -46,6 +46,8 @@ public class SearchResultReferenceDsml
/**
* Creates a new getDecoratedMessage() of SearchResultReferenceDsml.
+ *
+ * @param codec The LDAP Service to use
*/
public SearchResultReferenceDsml( LdapApiService codec )
{
@@ -56,8 +58,8 @@ public class SearchResultReferenceDsml
/**
* Creates a new getDecoratedMessage() of SearchResultReferenceDsml.
*
- * @param ldapMessage
- * the message to decorate
+ * @param codec The LDAP Service to use
+ * @param ldapMessage the message to decorate
*/
public SearchResultReferenceDsml( LdapApiService codec, SearchResultReference ldapMessage )
{