svn commit: r171173 - /incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java

[ri...@apache.org]

Author: rich
Date: Fri May 20 17:20:31 2005
New Revision: 171173

URL: http://svn.apache.org/viewcvs?rev=171173&view=rev
Log:
Minor JavaDoc update...


Modified:
    incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java

Modified: incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java?rev=171173&r1=171172&r2=171173&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java (original)
+++ incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/handler/LoginHandler.java Fri May 20 17:20:31 2005
@@ -50,13 +50,15 @@
      * Tell whether the current user is in a given role.
      * 
      * @param roleName the role to check.
-     * @return <code>true</code> if the current logged-in user is in the given role.
+     * @return <code>true</code> if there is a current logged-in user who is in the given role.
      */ 
     public boolean isUserInRole( FlowControllerHandlerContext context, String roleName );
     
     /**
      * Get the current user.
-     * @return a {@link Principal} that represents the current logged-in user.
+     *
+     * @return a {@link Principal} that represents the current logged-in user, or <code>null</code> if there is no
+     *             logged-in user.
      */ 
     public Principal getUserPrincipal( FlowControllerHandlerContext context );
 }