You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by hl...@apache.org on 2006/09/04 22:36:13 UTC

svn commit: r440180 - in /tapestry/tapestry5/tapestry-core/trunk/src: main/java/org/apache/tapestry/annotations/ main/java/org/apache/tapestry/internal/services/ main/java/org/apache/tapestry/internal/structure/ main/java/org/apache/tapestry/runtime/ m...

Author: hlship
Date: Mon Sep  4 13:36:12 2006
New Revision: 440180

URL: http://svn.apache.org/viewvc?view=rev&rev=440180
Log:
Rename render phase annotations (and corresponding ComponentLifecycle method names).

Added:
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/AfterRender.java
      - copied, changed from r440169, tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/RenderCloseTag.java
Removed:
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/RenderCloseTag.java
Modified:
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/BeginRender.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ComponentLifecycleMethodWorker.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/InternalModule.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ParameterWorker.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/structure/ComponentPageElementImpl.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/runtime/ComponentLifecycle.java
    tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/services/TransformConstants.java
    tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Loop.java
    tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Strong.java
    tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/bindings/DefaultComponentLifecyle.java
    tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/services/ParameterWorkerTest.java

Copied: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/AfterRender.java (from r440169, tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/RenderCloseTag.java)
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/AfterRender.java?view=diff&rev=440180&p1=tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/RenderCloseTag.java&r1=440169&p2=tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/AfterRender.java&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/RenderCloseTag.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/AfterRender.java Mon Sep  4 13:36:12 2006
@@ -22,17 +22,17 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Marker annotation for methods associated with the AfterRender phrase. This corresponds closely to
+ * Marker annotation for methods associated with the AfterRender phase. This corresponds closely to
  * {@link org.apache.tapestry.annotations.BeginRender}, but occurs after the template and body of
- * the component have been rendered. Return void or false will advance to the
- * {@link org.apache.tapestry.annotations.CleanupRender} phase. Return true will return to the
- * {@link org.apache.tapestry.annotations.BeginRender} phase.
+ * the component have been rendered. Often, this is used to render a close tag. Return void or false
+ * to advance to the {@link org.apache.tapestry.annotations.CleanupRender} phase. Return true to
+ * return to the {@link org.apache.tapestry.annotations.BeginRender} phase.
  * 
  * @author Howard M. Lewis Ship
  */
 @Target(ElementType.METHOD)
 @Retention(RUNTIME)
 @Documented
-public @interface RenderCloseTag {
+public @interface AfterRender {
 
 }

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/BeginRender.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/BeginRender.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/BeginRender.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/annotations/BeginRender.java Mon Sep  4 13:36:12 2006
@@ -23,7 +23,7 @@
 
 /**
  * Marker annotation for methods that should be executed at the start of rendering the component.
- * This usually includes rendering of the component's tag. Such methods may optionally take a
+ * This usually includes rendering of the component's start tag. Such methods may optionally take a
  * {@link org.apache.tapestry.MarkupWriter} parameter, and may return void or boolean. Returning
  * true or void will allow the component to advance into the render template / render body phase. If
  * a body is present, the {@link org.apache.tapestry.annotations.BeforeRenderBody} phase will

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ComponentLifecycleMethodWorker.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ComponentLifecycleMethodWorker.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ComponentLifecycleMethodWorker.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ComponentLifecycleMethodWorker.java Mon Sep  4 13:36:12 2006
@@ -56,6 +56,12 @@
         _methodAnnotation = methodAnnotation;
     }
 
+    @Override
+    public String toString()
+    {
+        return String.format("ComponentLifecycleMethodWorker[%s]", _methodAnnotation.getName());
+    }
+
     public void transform(ClassTransformation transformation, MutableComponentModel model)
     {
         List<MethodSignature> methods = transformation.findMethodsWithAnnotation(_methodAnnotation);

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/InternalModule.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/InternalModule.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/InternalModule.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/InternalModule.java Mon Sep  4 13:36:12 2006
@@ -20,7 +20,7 @@
 import org.apache.tapestry.annotations.BeforeRenderBody;
 import org.apache.tapestry.annotations.BeginRender;
 import org.apache.tapestry.annotations.CleanupRender;
-import org.apache.tapestry.annotations.RenderCloseTag;
+import org.apache.tapestry.annotations.AfterRender;
 import org.apache.tapestry.annotations.SetupRender;
 import org.apache.tapestry.events.InvalidationEvent;
 import org.apache.tapestry.events.InvalidationListener;
@@ -185,9 +185,9 @@
     public void contributeInternalWorkers(
             OrderedConfiguration<ComponentClassTransformWorker> configuration)
     {
-        configuration.add("Retain", new RetainWorker());
+        // TODO: Proper scheduling of all of this.
+
         configuration.add("Parameter", new ParameterWorker());
-        configuration.add("UnclaimedField", new UnclaimedFieldWorker(), "after:*.*");
 
         // Workers for the component rendering state machine methods; this is in typical
         // execution order.
@@ -195,8 +195,11 @@
         add(configuration, TransformConstants.SETUP_RENDER_SIGNATURE, SetupRender.class);
         add(configuration, TransformConstants.BEGIN_RENDER_SIGNATURE, BeginRender.class);
         add(configuration, TransformConstants.BEFORE_RENDER_BODY_SIGNATURE, BeforeRenderBody.class);
-        add(configuration, TransformConstants.RENDER_CLOSE_TAG_SIGNATURE, RenderCloseTag.class);
+        add(configuration, TransformConstants.AFTER_RENDER_SIGNATURE, AfterRender.class);
         add(configuration, TransformConstants.CLEANUP_RENDER_SIGNATURE, CleanupRender.class);
+
+        configuration.add("Retain", new RetainWorker());
+        configuration.add("UnclaimedField", new UnclaimedFieldWorker(), "after:*.*");
     }
 
     private void add(OrderedConfiguration<ComponentClassTransformWorker> configuration,

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ParameterWorker.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ParameterWorker.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ParameterWorker.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/services/ParameterWorker.java Mon Sep  4 13:36:12 2006
@@ -127,7 +127,7 @@
             builder.addln("%s = false;", cachedFieldName);
             builder.end();
 
-            transformation.extendMethod(TransformConstants.CLEANUP_AFTER_RENDER_SIGNATURE, builder
+            transformation.extendMethod(TransformConstants.POST_RENDER_CLEANUP_SIGNATURE, builder
                     .toString());
         }
 

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/structure/ComponentPageElementImpl.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/structure/ComponentPageElementImpl.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/structure/ComponentPageElementImpl.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/internal/structure/ComponentPageElementImpl.java Mon Sep  4 13:36:12 2006
@@ -293,7 +293,7 @@
         {
             LifecycleEvent<Boolean> event = newEvent(false);
 
-            _component.renderCloseTag(writer, event);
+            _component.afterRender(writer, event);
 
             if (event.getResult())
                 queue.push(_beginRender);
@@ -302,7 +302,7 @@
         @Override
         public String toString()
         {
-            return String.format("RenderCloseTag[%s]", getCompleteId());
+            return String.format("AfterRender[%s]", getCompleteId());
         }
 
     };
@@ -325,7 +325,7 @@
             {
                 _rendering = false;
 
-                _component.cleanupAfterRender();
+                _component.postRenderCleanup();
             }
         }
 

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/runtime/ComponentLifecycle.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/runtime/ComponentLifecycle.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/runtime/ComponentLifecycle.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/runtime/ComponentLifecycle.java Mon Sep  4 13:36:12 2006
@@ -35,13 +35,13 @@
      * this method, it is part of CleanupRender, but is always invoked. Its specific use is to allow
      * components to clean up cached parameter values.
      */
-    void cleanupAfterRender();
+    void postRenderCleanup();
 
     /**
      * Invoked before rendering a component (or its template).
      * <p>
      * Set event result to true to procede to {@link #renderTag(MarkupWriter)}, or false to skip to
-     * {@link #afterRender(MarkupWriter)}.
+     * {@link #cleanupRender(MarkupWriter)}.
      */
     void setupRender(MarkupWriter writer, LifecycleEvent<Boolean> event);
 
@@ -49,7 +49,7 @@
      * Invoked to allow a component to render its tag (start tag and attributes).
      * <p>
      * Set event result to true to render the component's template (eventually invoking
-     * {@link #beforeRenderBody(MarkupWriter)}, false to skip to {@link #afterRender(MarkupWriter)}.
+     * {@link #beforeRenderBody(MarkupWriter)}, false to skip to {@link #cleanupRender(MarkupWriter)}.
      */
     void beginRender(MarkupWriter writer, LifecycleEvent<Boolean> event);
 
@@ -67,9 +67,9 @@
      * again.
      * <p>
      * Set event result to true to return to {@link #renderTag(MarkupWriter)}, or false to advance
-     * to {@link #afterRender(MarkupWriter)}.
+     * to {@link #cleanupRender(MarkupWriter)}.
      */
-    void renderCloseTag(MarkupWriter writer, LifecycleEvent<Boolean> event);
+    void afterRender(MarkupWriter writer, LifecycleEvent<Boolean> event);
 
     /**
      * Generally used to perform final cleanup of the component after rendering.

Modified: tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/services/TransformConstants.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/services/TransformConstants.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/services/TransformConstants.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/main/java/org/apache/tapestry/services/TransformConstants.java Mon Sep  4 13:36:12 2006
@@ -41,9 +41,9 @@
     public static final MethodSignature CONTAINING_PAGE_DID_LOAD_SIGNATURE = new MethodSignature(
             "containingPageDidLoad");
 
-    /** Signature for {@link org.apache.tapestry.runtime.ComponentLifecycle#cleanupAfterRender()}. */
-    public static final MethodSignature CLEANUP_AFTER_RENDER_SIGNATURE = new MethodSignature(
-            "cleanupAfterRender");
+    /** Signature for {@link org.apache.tapestry.runtime.ComponentLifecycle#postRenderCleanup()}. */
+    public static final MethodSignature POST_RENDER_CLEANUP_SIGNATURE = new MethodSignature(
+            "postRenderCleanup");
 
     /**
      * Signature for
@@ -55,30 +55,40 @@
     /**
      * Signature for
      * {@link org.apache.tapestry.runtime.ComponentLifecycle#setupRender(MarkupWriter, LifecycleEvent)}.
+     * 
+     * @see org.apache.tapestry.annotations.SetupRender
      */
     public static final MethodSignature SETUP_RENDER_SIGNATURE = newLifecycleMethodSignature("setupRender");
 
     /**
      * Signature for
      * {@link org.apache.tapestry.runtime.ComponentLifecycle#beginRender(MarkupWriter, LifecycleEvent)}.
+     * 
+     * @see org.apache.tapestry.annotations.BeginRender
      */
     public static final MethodSignature BEGIN_RENDER_SIGNATURE = newLifecycleMethodSignature("beginRender");
 
     /**
      * Signature for
      * {@link org.apache.tapestry.runtime.ComponentLifecycle#beforeRenderBody(MarkupWriter, LifecycleEvent)}.
+     * 
+     * @see org.apache.tapestry.annotations.BeforeRenderBody
      */
     public static final MethodSignature BEFORE_RENDER_BODY_SIGNATURE = newLifecycleMethodSignature("beforeRenderBody");
 
     /**
      * Signature for
-     * {@link org.apache.tapestry.runtime.ComponentLifecycle#renderCloseTag(MarkupWriter, LifecycleEvent)}
+     * {@link org.apache.tapestry.runtime.ComponentLifecycle#afterRender(MarkupWriter, LifecycleEvent)}
+     * 
+     * @see org.apache.tapestry.annotations.AfterRender
      */
-    public static final MethodSignature RENDER_CLOSE_TAG_SIGNATURE = newLifecycleMethodSignature("renderCloseTag");
+    public static final MethodSignature AFTER_RENDER_SIGNATURE = newLifecycleMethodSignature("afterRender");
 
     /**
      * Signature for
      * {@link org.apache.tapestry.runtime.ComponentLifecycle#cleanupRender(MarkupWriter, LifecycleEvent)}.
+     * 
+     * @see org.apache.tapestry.annotations.CleanupRender
      */
     public static final MethodSignature CLEANUP_RENDER_SIGNATURE = newLifecycleMethodSignature("cleanupRender");
 

Modified: tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Loop.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Loop.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Loop.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Loop.java Mon Sep  4 13:36:12 2006
@@ -2,7 +2,7 @@
 
 import org.apache.tapestry.annotations.ComponentClass;
 import org.apache.tapestry.annotations.Parameter;
-import org.apache.tapestry.annotations.RenderCloseTag;
+import org.apache.tapestry.annotations.AfterRender;
 import org.apache.tapestry.annotations.SetupRender;
 
 @ComponentClass
@@ -23,7 +23,7 @@
         _value = _min;
     }
 
-    @RenderCloseTag
+    @AfterRender
     boolean startLoop()
     {
         int newValue = _value + 1;

Modified: tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Strong.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Strong.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Strong.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/integration/app1/components/Strong.java Mon Sep  4 13:36:12 2006
@@ -17,7 +17,7 @@
 import org.apache.tapestry.MarkupWriter;
 import org.apache.tapestry.annotations.BeginRender;
 import org.apache.tapestry.annotations.ComponentClass;
-import org.apache.tapestry.annotations.RenderCloseTag;
+import org.apache.tapestry.annotations.AfterRender;
 
 @ComponentClass
 public class Strong
@@ -28,7 +28,7 @@
         writer.element("strong");
     }
 
-    @RenderCloseTag
+    @AfterRender
     public void end(MarkupWriter writer)
     {
         writer.end();

Modified: tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/bindings/DefaultComponentLifecyle.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/bindings/DefaultComponentLifecyle.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/bindings/DefaultComponentLifecyle.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/bindings/DefaultComponentLifecyle.java Mon Sep  4 13:36:12 2006
@@ -13,7 +13,7 @@
 public class DefaultComponentLifecyle implements ComponentLifecycle
 {
 
-    public void cleanupAfterRender()
+    public void postRenderCleanup()
     {
     }
 
@@ -29,7 +29,7 @@
     {
     }
 
-    public void renderCloseTag(MarkupWriter writer, LifecycleEvent<Boolean> event)
+    public void afterRender(MarkupWriter writer, LifecycleEvent<Boolean> event)
     {
     }
 

Modified: tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/services/ParameterWorkerTest.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/services/ParameterWorkerTest.java?view=diff&rev=440180&r1=440179&r2=440180
==============================================================================
--- tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/services/ParameterWorkerTest.java (original)
+++ tapestry/tapestry5/tapestry-core/trunk/src/test/java/org/apache/tapestry/internal/services/ParameterWorkerTest.java Mon Sep  4 13:36:12 2006
@@ -76,7 +76,7 @@
 
         assertSame(_access.get(component, "invariantObject"), value);
 
-        component.cleanupAfterRender();
+        component.postRenderCleanup();
 
         // Still cached ...
 
@@ -118,7 +118,7 @@
 
         assertEquals(_access.get(component, "invariantPrimitive"), value);
 
-        component.cleanupAfterRender();
+        component.postRenderCleanup();
 
         // Still cached ...
 
@@ -174,7 +174,7 @@
 
         replay();
 
-        component.cleanupAfterRender();
+        component.postRenderCleanup();
 
         assertEquals(_access.get(component, "object"), "fourth");
 
@@ -220,7 +220,7 @@
 
         replay();
 
-        component.cleanupAfterRender();
+        component.postRenderCleanup();
 
         assertEquals(_access.get(component, "object"), "fourth");
 
@@ -266,7 +266,7 @@
 
         replay();
 
-        component.cleanupAfterRender();
+        component.postRenderCleanup();
 
         assertEquals(_access.get(component, "primitive"), 890);