[jira] Created: (BEEHIVE-871) Incorrect JavaDoc comment on org.apache.beehive.controls.spi.svc.Interceptor

["Xibin Zeng (JIRA)" <be...@incubator.apache.org>]

Incorrect JavaDoc comment on org.apache.beehive.controls.spi.svc.Interceptor
----------------------------------------------------------------------------

         Key: BEEHIVE-871
         URL: http://issues.apache.org/jira/browse/BEEHIVE-871
     Project: Beehive
        Type: Bug
  Components: Controls  
    Versions: v1m1, V1Beta, V1Alpha    
 Environment: N/A
    Reporter: Xibin Zeng
    Priority: Trivial


The actual mechanism for an Interceptor to pivot an execution flow is by throwing a InterceptorPivotException. However, the header comment reads:

* A return value of "true" from each Interceptor method indicates to the runtime
 * that it should continue execution through the normal flow of control (ie, subsequent
 * interceptors and operation/event execution).  "false" indicates that the interceptor
 * has fully processed the operation and the runtime should "pivot" out.

The above comment should be corrected so a user is not mislead.

Thanks

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira