From 9c369c29d95d7c6720bb0f7d01b2be04a1e73047 Mon Sep 17 00:00:00 2001
From: Peter Reilly <peterreilly@apache.org>
Date: Wed, 18 Feb 2004 16:01:14 +0000
Subject: [PATCH] Make note in FAQ about taskcontainer differences between ant
 1.6 and ant 1.6

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@276108 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/faq.html | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++
 xdocs/faq.xml | 50 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)

diff --git a/docs/faq.html b/docs/faq.html
index 89a95f917..370fd7c61 100644
--- a/docs/faq.html
+++ b/docs/faq.html
@@ -335,6 +335,12 @@
       </a></li>
                 <li><a href="#1.5.2-zip-broken">
   <code>&lt;zip&gt;</code> is broken in Ant 1.5.2.
+      </a></li>
+                <li><a href="#unknownelement.taskcontainer">
+  
+        Why do my custom task containers see Unknown Elements in Ant 1.6
+        - they worked in Ant 1.5?
+      
       </a></li>
             </ul>
     
@@ -1538,6 +1544,55 @@ mv /tmp/foo $ANT_HOME/bin/antRun
         17871</a> and <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=18403">Bug
         18403</a>.  All of them are supposed to be fixed with Ant
         1.5.3 (and only 18403 should exist in 1.5.3beta1).</p>
+                    <p class="faq">
+      <a name="unknownelement.taskcontainer"></a>
+      
+        Why do my custom task containers see Unknown Elements in Ant 1.6
+        - they worked in Ant 1.5?
+      
+    </p>
+                  <p>
+          The objects added in TaskContainer.addTask(Task task)
+          have changed from  Tasks to UnknownElements.
+        </p>
+                        <p>
+          There was a number of valid reasons for this change. But the backward
+          compatibility problems were not noticied until after Ant 1.6.0 was
+          released.
+        </p>
+                        <p>
+          Your container class will need to be modified to check if the Task
+          is an UnknownElement and call perform on it to
+          convert it to a Task and to execute it.
+          (see apache.tools.ant.taskdefs.Sequential)
+        </p>
+                        <p>
+          If you want to do more processing on the task,
+          you need to use the techniques in apache.tools.ant.taskdefs.Antlib#execute()
+          This does make use of one 1.6 method call (UE#getRealObject()),
+          you need to use UE#getTask() instread - this will
+          return null for non tasks (types like fileset id=x).
+        </p>
+                        <p>
+          So.. interate over the tasks, if they are UEs, convert them to
+          tasks, using UE#maybeConfigure and UE#getTask()
+        </p>
+                        <pre class="code">
+        for (Iterator i = tasks.iterator(); i.hasNext();) {
+           Task t = (Task) i.next();
+           if (t instanceof UnknownElement) {
+              ((UnknownElement) t).maybeConfigure();
+              t = ((UnknownElement) t).getTask();
+              if (t == null) {
+                  continue;
+              }
+           }
+           // .... original Custom code
+        }
+        </pre>
+                        <p>
+          This approach should work for ant1.5 and ant1.6.
+        </p>
                     </div>
   </div>
 
diff --git a/xdocs/faq.xml b/xdocs/faq.xml
index db168a070..b4825cbac 100644
--- a/xdocs/faq.xml
+++ b/xdocs/faq.xml
@@ -1359,6 +1359,56 @@ mv /tmp/foo $ANT_HOME/bin/antRun
       </answer>
     </faq>
 
+    <faq id="unknownelement.taskcontainer">
+      <question>
+        Why do my custom task containers see Unknown Elements in Ant 1.6
+        - they worked in Ant 1.5?
+      </question>
+      <answer>
+        <p>
+          The objects added in TaskContainer.addTask(Task task)
+          have changed from  Tasks to UnknownElements.
+        </p>
+        <p>
+          There was a number of valid reasons for this change. But the backward
+          compatibility problems were not noticied until after Ant 1.6.0 was
+          released.
+        </p>
+        <p>
+          Your container class will need to be modified to check if the Task
+          is an UnknownElement and call perform on it to
+          convert it to a Task and to execute it.
+          (see apache.tools.ant.taskdefs.Sequential)
+        </p>
+        <p>
+          If you want to do more processing on the task,
+          you need to use the techniques in apache.tools.ant.taskdefs.Antlib#execute()
+          This does make use of one 1.6 method call (UE#getRealObject()),
+          you need to use UE#getTask() instread - this will
+          return null for non tasks (types like fileset id=x).
+        </p>
+        <p>
+          So.. interate over the tasks, if they are UEs, convert them to
+          tasks, using UE#maybeConfigure and UE#getTask()
+        </p>
+        <source><![CDATA[
+        for (Iterator i = tasks.iterator(); i.hasNext();) {
+           Task t = (Task) i.next();
+           if (t instanceof UnknownElement) {
+              ((UnknownElement) t).maybeConfigure();
+              t = ((UnknownElement) t).getTask();
+              if (t == null) {
+                  continue;
+              }
+           }
+           // .... original Custom code
+        }
+        ]]></source>
+        <p>
+          This approach should work for ant1.5 and ant1.6.
+        </p>
+      </answer>
+    </faq>
   </faqsection>
 
 </document>