svn commit: r746575 - in /cxf/branches/2.1.x-fixes: ./ api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java

[bi...@apache.org]

Author: bimargulies
Date: Sat Feb 21 19:54:00 2009
New Revision: 746575

URL: http://svn.apache.org/viewvc?rev=746575&view=rev
Log:
Merged revisions 746070 via svnmerge from 
https://svn.apache.org/repos/asf/cxf/trunk

........
  r746070 | ericjohnson | 2009-02-19 19:32:27 -0500 (Thu, 19 Feb 2009) | 1 line
  
  clarified some of the Javadoc comments.
........

Modified:
    cxf/branches/2.1.x-fixes/   (props changed)
    cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java

Propchange: cxf/branches/2.1.x-fixes/
------------------------------------------------------------------------------
Binary property 'svnmerge-integrated' - no diff available.

Modified: cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java
URL: http://svn.apache.org/viewvc/cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java?rev=746575&r1=746574&r2=746575&view=diff
==============================================================================
--- cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java (original)
+++ cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/PhaseInterceptor.java Sat Feb 21 19:54:00 2009
@@ -25,38 +25,42 @@
 import org.apache.cxf.message.Message;
 
 /**
- * A phase interceptor participates in a PhaseInterceptorChain.
- * <pre>
- * The before and after properties contain a list of Ids that can control 
- * where in the chain the interceptor is placed relative to other interceptors
- * </pre> 
+ * A phase interceptor is an intercetor that participates in a 
+ * PhaseInterceptorChain.
+ * The phase property controls the phase in which the interceptor is placed.
+ * The before and after properties allow for fine grained control over where 
+ * the phase the interceptor is placed. They specify the IDs of the 
+ * interceptors that must be placed before and after the interceptor.
+ *
  * @see org.apache.cxf.phase.PhaseInterceptorChain
  * @author Dan Diephouse
  */
 public interface PhaseInterceptor<T extends Message> extends Interceptor<T> {
 
     /**
-     * Returns a set of IDs specifying the interceptors that this interceptor should 
-     * be placed after in the interceptor chain
-     * @return the ids of the interceptors
+     * Returns a set containing the IDs of the interceptors that should be 
+     * executed before this interceptor. This interceptor will be placed 
+     * in the chain after the interceptors in the set.
+     * @return the IDs of the interceptors
      */
     Set<String> getAfter();
 
     /**
-     * Returns a set of IDs specifying the interceptors that this interceptor needs 
-     * to be before in the inteceptor chain.
+     * Returns a set containing the IDs of the interceptors that should be 
+     * executed after this interceptor. This interceptor will be placed in 
+     * the inteceptor chain before the interceptors in the set.
      * @return the ids of the interceptors 
      */
     Set<String> getBefore();
 
     /**
-     * The ID of this interceptor.
-     * @return the id
+     * Returns the ID of this interceptor.
+     * @return the ID
      */
     String getId();
 
     /**
-     * The phase of this interceptor.
+     * Returns the phase in which this interceptor is excecuted.
      * @return the phase
      */
     String getPhase();