svn commit: r709130 - /mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java

[ngn]

Author: ngn
Date: Thu Oct 30 03:07:02 2008
New Revision: 709130

URL: http://svn.apache.org/viewvc?rev=709130&view=rev
Log:
Fixed incorrect Javadoc (FTPSERVER-206)

Modified:
    
mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java

Modified: 
mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
URL: 
http://svn.apache.org/viewvc/mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java?rev=709130&r1=709129&r2=709130&view=diff
==============================================================================
--- 
mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
 (original)
+++ 
mina/ftpserver/trunk/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
 Thu Oct 30 03:07:02 2008
@@ -42,10 +42,11 @@
      * 
      * @param request
      *            The [EMAIL PROTECTED] AuthorizationRequest}
-     * @return True if the request is authorized, false otherwise If the 
request
-     *         can not be authorized (as checked by
-     *         [EMAIL PROTECTED] #canAuthorize(AuthorizationRequest)} by this 
Authority,
-     *         false is returned.
+     * @return Returns a populated AuthorizationRequest as long as If
+     *         [EMAIL PROTECTED] #canAuthorize(AuthorizationRequest)} returns 
true for the 
+     *         AuthorizationRequest, otherwise returns null. 
+     *         [EMAIL PROTECTED] #canAuthorize(AuthorizationRequest)} should 
always be checked before 
+     *         calling this method.
      */
     AuthorizationRequest authorize(AuthorizationRequest request);
 }