You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2010/09/28 22:47:00 UTC
svn commit: r1002352 -
/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/
Author: seelmann
Date: Tue Sep 28 20:46:59 2010
New Revision: 1002352
URL: http://svn.apache.org/viewvc?rev=1002352&view=rev
Log:
Fixed checkstyle errors, javadocs, and formatting
Modified:
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/AddFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/BindFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/CompareFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/DeleteFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyDnFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/AddFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/AddFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/AddFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/AddFuture.java Tue Sep 28 20:46:59 2010
@@ -29,17 +29,16 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage AddRequests
+ * A Future to manage AddRequests.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class AddFuture extends ResponseFuture<AddResponse>
{
/**
- *
* Creates a new instance of AddFuture.
*
- * @param connection The LdapConnection
+ * @param connection the LDAP connection
* @param messageId The associated messageId
*/
public AddFuture( LdapConnection connection, int messageId )
@@ -51,7 +50,9 @@ public class AddFuture extends ResponseF
/**
* Get the AddResponse, blocking until one is received.
*
- * @return The AddResponse
+ * @return the add response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public AddResponse get() throws InterruptedException, ExecutionException
{
@@ -63,9 +64,12 @@ public class AddFuture extends ResponseF
* Get the AddResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The AddResponse The AddResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the add response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public AddResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/BindFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/BindFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/BindFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/BindFuture.java Tue Sep 28 20:46:59 2010
@@ -29,18 +29,17 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage BindRequests
+ * A Future to manage BindRequests.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class BindFuture extends ResponseFuture<BindResponse>
{
/**
- *
* Creates a new instance of BindFuture.
*
- * @param connection The LdapConnection
- * @param messageId The associated messageId
+ * @param connection the LDAP connection
+ * @param messageId the associated messageId
*/
public BindFuture( LdapConnection connection, int messageId )
{
@@ -51,7 +50,9 @@ public class BindFuture extends Response
/**
* Get the BindResponse, blocking until one is received.
*
- * @return The BindResponse
+ * @return the bind response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public BindResponse get() throws InterruptedException, ExecutionException
{
@@ -63,9 +64,12 @@ public class BindFuture extends Response
* Get the BindResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The BindResponse The BindResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the bind response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public BindResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/CompareFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/CompareFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/CompareFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/CompareFuture.java Tue Sep 28 20:46:59 2010
@@ -29,18 +29,17 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage CompareRequest
+ * A Future to manage CompareRequest.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class CompareFuture extends ResponseFuture<CompareResponse>
{
/**
- *
* Creates a new instance of CompareFuture.
*
- * @param connection The LdapConnection
- * @param messageId The associated messageId
+ * @param connection the LDAP connection
+ * @param messageId the associated messageId
*/
public CompareFuture( LdapConnection connection, int messageId )
{
@@ -51,7 +50,9 @@ public class CompareFuture extends Respo
/**
* Get the CompareResponse, blocking until one is received.
*
- * @return The CompareResponse
+ * @return the compare response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public CompareResponse get() throws InterruptedException, ExecutionException
{
@@ -63,9 +64,12 @@ public class CompareFuture extends Respo
* Get the CompareResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The CompareResponse The CompareResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the compare response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public CompareResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/DeleteFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/DeleteFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/DeleteFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/DeleteFuture.java Tue Sep 28 20:46:59 2010
@@ -29,17 +29,16 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage DelRequests
+ * A Future to manage DeleteRequests.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class DeleteFuture extends ResponseFuture<DeleteResponse>
{
/**
- *
- * Creates a new instance of AddFuture.
+ * Creates a new instance of DeleteFuture.
*
- * @param connection The LdapConnection
+ * @param connection the LDAP connection
* @param messageId The associated messageId
*/
public DeleteFuture( LdapConnection connection, int messageId )
@@ -51,7 +50,9 @@ public class DeleteFuture extends Respon
/**
* Get the DeleteResponse, blocking until one is received.
*
- * @return The DeleteResponse
+ * @return the delete response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public DeleteResponse get() throws InterruptedException, ExecutionException
{
@@ -63,9 +64,12 @@ public class DeleteFuture extends Respon
* Get the DeleteResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The DeleteResponse The DeleteResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the delete response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public DeleteResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java Tue Sep 28 20:46:59 2010
@@ -29,16 +29,17 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage ExtendedRequests
+ * A Future to manage ExtendedRequests.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ExtendedFuture extends ResponseFuture<Response>
{
/**
- *
* Creates a new instance of ExtendedFuture.
*
+ * @param connection the LDAP connection
+ * @param messageId The associated messageId
*/
public ExtendedFuture( LdapConnection connection, int messageId )
{
@@ -49,7 +50,9 @@ public class ExtendedFuture extends Resp
/**
* Get the ExtendedResponse, blocking until one is received.
*
- * @return The ExtendedResponse
+ * @return the extended response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public Response get() throws InterruptedException, ExecutionException
{
@@ -61,9 +64,12 @@ public class ExtendedFuture extends Resp
* Get the ExtendedResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The ExtendedResponse The ExtendedResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the extended response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyDnFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyDnFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyDnFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyDnFuture.java Tue Sep 28 20:46:59 2010
@@ -36,10 +36,9 @@ import org.apache.directory.shared.ldap.
public class ModifyDnFuture extends ResponseFuture<ModifyDnResponse>
{
/**
- *
* Creates a new instance of ModifyDnFuture.
*
- * @param connection The LdapConnection
+ * @param connection the LDAP connection
* @param messageId The associated messageId
*/
public ModifyDnFuture( LdapConnection connection, int messageId )
@@ -51,7 +50,9 @@ public class ModifyDnFuture extends Resp
/**
* Get the ModifyDnResponse, blocking until one is received.
*
- * @return The ModifyDnResponse
+ * @return the modify DN response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public ModifyDnResponse get() throws InterruptedException, ExecutionException
{
@@ -63,9 +64,12 @@ public class ModifyDnFuture extends Resp
* Get the ModifyDnResponse, blocking until one is received, or until the
* given timeout is reached.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The ModifyDnResponse The ModifyDnResponse found
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the modify DN response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public ModifyDnResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ModifyFuture.java Tue Sep 28 20:46:59 2010
@@ -29,17 +29,16 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage ModifyRequest
+ * A Future to manage ModifyRequest.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ModifyFuture extends ResponseFuture<ModifyResponse>
{
/**
- *
* Creates a new instance of ModifyFuture.
*
- * @param connection The LdapConnection
+ * @param connection the LDAP connection
* @param messageId The associated messageId
*/
public ModifyFuture( LdapConnection connection, int messageId )
@@ -50,8 +49,10 @@ public class ModifyFuture extends Respon
/**
* Get the ModifyResponse, blocking until one is received.
- *
- * @return The ModifyResponse
+ *
+ * @return the modify response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public ModifyResponse get() throws InterruptedException, ExecutionException
{
@@ -62,10 +63,13 @@ public class ModifyFuture extends Respon
/**
* Get the ModifyResponse, blocking until one is received, or until the
* given timeout is reached.
- *
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The ModifyResponse The ModifyResponse found
+ *
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the modify response
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public ModifyResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java Tue Sep 28 20:46:59 2010
@@ -29,6 +29,7 @@ import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.apache.directory.ldap.client.api.LdapConnection;
+import org.apache.directory.shared.ldap.message.Response;
/**
@@ -37,7 +38,7 @@ import org.apache.directory.ldap.client.
* @param <R> The result type returned by this Future's <tt>get</tt> method
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class ResponseFuture<R> implements Future<R>
+public class ResponseFuture<R extends Response> implements Future<Response>
{
/** the blocking queue holding LDAP responses */
protected BlockingQueue<R> queue;
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java?rev=1002352&r1=1002351&r2=1002352&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java Tue Sep 28 20:46:59 2010
@@ -29,17 +29,16 @@ import org.apache.directory.shared.ldap.
/**
- * A Future to manage SerachRequest
+ * A Future to manage SerachRequest.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class SearchFuture extends ResponseFuture<Response>
{
/**
- *
* Creates a new instance of SearchFuture.
*
- * @param connection The LdapConnection
+ * @param connection the LDAP connection
* @param messageId The associated messageId
*/
public SearchFuture( LdapConnection connection, int messageId )
@@ -51,9 +50,11 @@ public class SearchFuture extends Respon
/**
* Get the SearchResponse, blocking until one is received.
* It can be either a SearchResultEntry, a SearchResultReference
- * or a SearchResultDone, the last of all the SearchResponse.
+ * or a SearchResultDone, the last of all the search responses.
*
- * @return The SearchResponse
+ * @return the response, either a SearchResultEntry, a SearchResultReference, or a SearchResultDone
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
*/
public Response get() throws InterruptedException, ExecutionException
{
@@ -63,11 +64,19 @@ public class SearchFuture extends Respon
/**
* Get the SearchResponse, blocking until one is received, or until the
- * given timeout is reached.
+ * given timeout is reached. It can be either a SearchResultEntry,
+ * a SearchResultReference or a SearchResultDone, the last of all
+ * the search responses.
*
- * @param timeout Number of TimeUnit to wait
- * @param unit The TimeUnit
- * @return The SearchResponse The SearchResponse found
+ * Get the ModifyResponse, blocking until one is received, or until the
+ * given timeout is reached.
+ *
+ * @param timeout {@inheritDoc}
+ * @param unit {@inheritDoc}
+ * @return the response, either a SearchResultEntry, a SearchResultReference, or a SearchResultDone
+ * @throws InterruptedException {@inheritDoc}
+ * @throws ExecutionException {@inheritDoc}
+ * @throws TimeoutException {@inheritDoc}
*/
public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
TimeoutException