svn commit: r290894 - /beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java

[ek...@apache.org]

Author: ekoneil
Date: Wed Sep 21 22:29:34 2005
New Revision: 290894

URL: http://svn.apache.org/viewcvs?rev=290894&view=rev
Log:
Fix for JIRA 871 -- fixup Controls Interceptor Javadoc.

BB: self
Test: Controls DRT pass


Modified:
    beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java

Modified: beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java?rev=290894&r1=290893&r2=290894&view=diff
==============================================================================
--- beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java (original)
+++ beehive/trunk/controls/src/spi/org/apache/beehive/controls/spi/svc/Interceptor.java Wed Sep 21 22:29:34 2005
@@ -1,4 +1,3 @@
-package org.apache.beehive.controls.spi.svc;
 /*
  * Copyright 2004 The Apache Software Foundation.
  *
@@ -16,11 +15,12 @@
  *
  * $Header:$
  */
-
-import org.apache.beehive.controls.api.bean.ControlBean;
+package org.apache.beehive.controls.spi.svc;
 
 import java.lang.reflect.Method;
 
+import org.apache.beehive.controls.api.bean.ControlBean;
+
 /**
  * The controls implementation architecture has a interceptor model for
  * adding annotation-based features.  This model provides the ability to
@@ -33,22 +33,24 @@
  * implementations of interceptors at the appropriate execution points
  * (pre/post invocation of a control operation, etc).
  *
- * 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 control runtime will continue the normal flow of control (ie, subsequent
+ * interceptors and operation/event execution) unless an interceptor throws a
+ * {@link InterceptorPivotException}.  When this type of execption is encountered,
+ * the runtime will "pivot" out.
  */
 public interface Interceptor
 {
     /** Called before a control operation is invoked */
     public void preInvoke( ControlBean cb, Method m, Object [] args)
     	throws InterceptorPivotException;
+
     /** Called after a control operation is invoked */
     public void postInvoke( ControlBean cb, Method m, Object [] args, Object retval, Throwable t );
 
     /** Called before a control event is fired (through a client proxy) */
     public void preEvent( ControlBean cb, Class eventSet, Method m, Object [] args )
     	throws InterceptorPivotException;
+
     /** Called after a control event is fired (through a client proxy) */
     public void postEvent( ControlBean cb, Class eventSet, Method m, Object [] args);
 }