From 22cc386d2e7f1d3d13c3debbea5a916f84ae3362 Mon Sep 17 00:00:00 2001 From: Matthew Jason Benson Date: Wed, 21 Apr 2010 16:08:10 +0000 Subject: [PATCH] Added the augment task to manipulate existing references via Ant's basic introspection mechanisms. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@936382 13f79535-47bb-0310-9956-ffa450edef68 --- WHATSNEW | 3 + docs/manual/CoreTasks/augment.html | 83 +++++++++++++++++++ docs/manual/coretasklist.html | 1 + .../tools/ant/taskdefs/AugmentReference.java | 72 ++++++++++++++++ .../tools/ant/taskdefs/defaults.properties | 1 + src/tests/antunit/taskdefs/augment-test.xml | 74 +++++++++++++++++ 6 files changed, 234 insertions(+) create mode 100644 docs/manual/CoreTasks/augment.html create mode 100644 src/main/org/apache/tools/ant/taskdefs/AugmentReference.java create mode 100644 src/tests/antunit/taskdefs/augment-test.xml diff --git a/WHATSNEW b/WHATSNEW index 2b725fdd8..b002ada38 100644 --- a/WHATSNEW +++ b/WHATSNEW @@ -141,6 +141,9 @@ Other changes: * supports new attributes enablemultiplemappings and cache. + * Added the augment task to manipulate existing references via Ant's basic + introspection mechanisms. + Changes from Ant 1.8.0RC1 TO Ant 1.8.0 ====================================== diff --git a/docs/manual/CoreTasks/augment.html b/docs/manual/CoreTasks/augment.html new file mode 100644 index 000000000..f5f4c44e8 --- /dev/null +++ b/docs/manual/CoreTasks/augment.html @@ -0,0 +1,83 @@ + + + + + + +Augment Task + + + + +

Augment

+ +

Description

+

Modify an existing reference by adding nested elements or (re-)assigning properties +mapped as XML attributes. This is an unusual task that makes use of Ant's internal +processing mechanisms to reload a previously declared reference by means of the 'id' +attribute, then treats the declared augment element as though it were the +original element. +Since Ant 1.8.1

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
idThe id of the reference to augment. If no such reference has + been declared a BuildException is generated.Yes
+

+Additional permissible attributes are dependent on the reference to be modified. +

+ +

Parameters specified as nested elements

+ +

+Permissible nested elements are dependent on the reference to be modified. +

+ +

Examples

+ +Given +
+  <fileset id="input-fs" dir="${basedir}" />
+
+ +
+  <augment id="input-fs" excludes="foo" />
+
+ +

Modifies the excludes attribute of input-fs.

+ +
+  <augment id="input-fs">
+    <filename name="bar" />
+  </augment>
+
+ +

Adds a filename selector to input-fs.

+ + + diff --git a/docs/manual/coretasklist.html b/docs/manual/coretasklist.html index 3d3fcdecd..9be06174b 100644 --- a/docs/manual/coretasklist.html +++ b/docs/manual/coretasklist.html @@ -41,6 +41,7 @@
  • AntVersion
  • Apply/ExecOn
  • Apt
    • +
  • Augment
  • Available
  • Basename
  • BuildNumber
    • diff --git a/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java b/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java new file mode 100644 index 000000000..69d774d3c --- /dev/null +++ b/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java @@ -0,0 +1,72 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package org.apache.tools.ant.taskdefs; + +import org.apache.tools.ant.RuntimeConfigurable; +import org.apache.tools.ant.Task; +import org.apache.tools.ant.TypeAdapter; + +/** + * Ant task to dynamically augment a previously declared reference. + * @since Ant 1.8.1 + */ +public class AugmentReference extends Task implements TypeAdapter { + private String id; + + /** + * {@inheritDoc} + */ + public void checkProxyClass(Class proxyClass) { + } + + /** + * {@inheritDoc} + */ + public synchronized Object getProxy() { + if (getProject() == null) { + throw new IllegalStateException(getTaskName() + "Project owner unset"); + } + hijackId(); + if (getProject().hasReference(id)) { + Object result = getProject().getReference(id); + log("project reference " + id + "=" + String.valueOf(result)); + return result; + } + throw new IllegalStateException("Unknown reference \"" + id + "\""); + } + + /** + * {@inheritDoc} + */ + public void setProxy(Object o) { + throw new UnsupportedOperationException(); + } + + private synchronized void hijackId() { + if (id == null) { + RuntimeConfigurable wrapper = getWrapper(); + id = wrapper.getId(); + if (id == null) { + throw new IllegalStateException(getTaskName() + " attribute 'id' unset"); + } + wrapper.setAttribute("id", null); + wrapper.removeAttribute("id"); + wrapper.setElementTag("augmented reference \"" + id + "\""); + } + } +} diff --git a/src/main/org/apache/tools/ant/taskdefs/defaults.properties b/src/main/org/apache/tools/ant/taskdefs/defaults.properties index 75be825e5..b99d44cf7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/defaults.properties +++ b/src/main/org/apache/tools/ant/taskdefs/defaults.properties @@ -20,6 +20,7 @@ antstructure=org.apache.tools.ant.taskdefs.AntStructure antversion=org.apache.tools.ant.taskdefs.condition.AntVersion apply=org.apache.tools.ant.taskdefs.Transform apt=org.apache.tools.ant.taskdefs.Apt +augment=org.apache.tools.ant.taskdefs.AugmentReference available=org.apache.tools.ant.taskdefs.Available basename=org.apache.tools.ant.taskdefs.Basename buildnumber=org.apache.tools.ant.taskdefs.BuildNumber diff --git a/src/tests/antunit/taskdefs/augment-test.xml b/src/tests/antunit/taskdefs/augment-test.xml new file mode 100644 index 000000000..2e6f3354f --- /dev/null +++ b/src/tests/antunit/taskdefs/augment-test.xml @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +