- /*
- * Copyright 2000-2004 The Apache Software Foundation
- *
- * Licensed 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;
-
- import java.io.Serializable;
- import java.util.ArrayList;
- import java.util.Collections;
- import java.util.Enumeration;
- import java.util.HashMap;
- import java.util.Hashtable;
- import java.util.List;
- import java.util.Locale;
- import java.util.Map;
- import java.util.Iterator;
-
- import org.apache.tools.ant.util.CollectionUtils;
- import org.xml.sax.AttributeList;
- import org.xml.sax.helpers.AttributeListImpl;
-
- /**
- * Wrapper class that holds the attributes of an element, its children, and
- * any text within it. It then takes care of configuring that element at
- * runtime.
- *
- */
- public class RuntimeConfigurable implements Serializable {
-
- /** Polymorphic attribute (May be XML NS attribute later) */
- private static final String ANT_TYPE = "ant-type";
-
- /** Name of the element to configure. */
- private String elementTag = null;
-
- /** List of child element wrappers. */
- private List/*<RuntimeConfigurable>*/ children = null;
-
- /** The element to configure. It is only used during
- * maybeConfigure.
- */
- private transient Object wrappedObject = null;
-
- /** the creator used to make the wrapped object */
- private transient IntrospectionHelper.Creator creator;
-
- /**
- * @deprecated
- * XML attributes for the element.
- */
- private transient AttributeList attributes;
-
- /** Attribute names and values. While the XML spec doesn't require
- * preserving the order ( AFAIK ), some ant tests do rely on the
- * exact order. The following code is copied from AttributeImpl.
- * We could also just use SAX2 Attributes and convert to SAX1 ( DOM
- * attribute Nodes can also be stored in SAX2 Attributes )
- * XXX under JDK 1.4 you can just use a LinkedHashMap for this purpose -jglick
- */
- private List/*<String>*/ attributeNames = null;
-
- /** Map of attribute names to values */
- private Map/*<String,String>*/ attributeMap = null;
-
- /** Text appearing within the element. */
- private StringBuffer characters = null;
-
- /** Indicates if the wrapped object has been configured */
- private boolean proxyConfigured = false;
-
- /** the polymorphic type */
- private String polyType = null;
-
- /**
- * Sole constructor creating a wrapper for the specified object.
- *
- * @param proxy The element to configure. Must not be <code>null</code>.
- * @param elementTag The tag name generating this element.
- * Should not be <code>null</code>.
- */
- public RuntimeConfigurable(Object proxy, String elementTag) {
- wrappedObject = proxy;
- this.elementTag = elementTag;
- proxyConfigured = false;
- // Most likely an UnknownElement
- if (proxy instanceof Task) {
- ((Task) proxy).setRuntimeConfigurableWrapper(this);
- }
- }
-
- /**
- * Sets the element to configure.
- *
- * @param proxy The element to configure. Must not be <code>null</code>.
- */
- public void setProxy(Object proxy) {
- wrappedObject = proxy;
- proxyConfigured = false;
- }
-
- /**
- * Sets the creator of the element to be configured
- * used to store the element in the parent;
- *
- * @param creator the creator object
- */
- void setCreator(IntrospectionHelper.Creator creator) {
- this.creator = creator;
- }
-
- /**
- * Get the object for which this RuntimeConfigurable holds the configuration
- * information
- *
- * @return the object whose configure is held by this instance.
- */
- public Object getProxy() {
- return wrappedObject;
- }
-
- /**
- * get the polymorphic type for this element
- * @return the ant component type name, null if not set
- */
- public String getPolyType() {
- return polyType;
- }
-
- /**
- * set the polymorphic type for this element
- * @param polyType the ant component type name, null if not set
- */
- public void setPolyType(String polyType) {
- this.polyType = polyType;
- }
-
- /**
- * Sets the attributes for the wrapped element.
- *
- * @deprecated
- * @param attributes List of attributes defined in the XML for this
- * element. May be <code>null</code>.
- */
- public void setAttributes(AttributeList attributes) {
- this.attributes = new AttributeListImpl(attributes);
- for (int i = 0; i < attributes.getLength(); i++) {
- setAttribute(attributes.getName(i), attributes.getValue(i));
- }
- }
-
- /**
- * Set an attribute to a given value
- *
- * @param name the name of the attribute.
- * @param value the attribute's value.
- */
- public void setAttribute(String name, String value) {
- if (name.equalsIgnoreCase(ANT_TYPE)) {
- this.polyType = value;
- } else {
- if (attributeNames == null) {
- attributeNames = new ArrayList();
- attributeMap = new HashMap();
- }
- attributeNames.add(name);
- attributeMap.put(name, value);
- }
- }
-
- /** Return the attribute map.
- *
- * @return Attribute name to attribute value map
- */
- public Hashtable getAttributeMap() {
- if (attributeMap != null) {
- return new Hashtable(attributeMap);
- } else {
- return new Hashtable(1);
- }
- }
-
- /**
- * Returns the list of attributes for the wrapped element.
- *
- * @deprecated
- * @return An AttributeList representing the attributes defined in the
- * XML for this element. May be <code>null</code>.
- */
- public AttributeList getAttributes() {
- return attributes;
- }
-
- /**
- * Adds a child element to the wrapped element.
- *
- * @param child The child element wrapper to add to this one.
- * Must not be <code>null</code>.
- */
- public void addChild(RuntimeConfigurable child) {
- if (children == null) {
- children = new ArrayList();
- }
- children.add(child);
- }
-
- /**
- * Returns the child wrapper at the specified position within the list.
- *
- * @param index The index of the child to return.
- *
- * @return The child wrapper at position <code>index</code> within the
- * list.
- */
- RuntimeConfigurable getChild(int index) {
- return (RuntimeConfigurable) children.get(index);
- }
-
- /**
- * Returns an enumeration of all child wrappers.
- * @return an enumeration of the child wrappers.
- * @since Ant 1.5.1
- */
- public Enumeration getChildren() {
- if (children != null) {
- return Collections.enumeration(children);
- } else {
- return new CollectionUtils.EmptyEnumeration();
- }
- }
-
- /**
- * Adds characters from #PCDATA areas to the wrapped element.
- *
- * @param data Text to add to the wrapped element.
- * Should not be <code>null</code>.
- */
- public void addText(String data) {
- if (data.length() == 0) {
- return;
- }
- if (characters != null) {
- characters.append(data);
- } else {
- characters = new StringBuffer(data);
- }
- }
-
- /**
- * Adds characters from #PCDATA areas to the wrapped element.
- *
- * @param buf A character array of the text within the element.
- * Must not be <code>null</code>.
- * @param start The start element in the array.
- * @param count The number of characters to read from the array.
- *
- */
- public void addText(char[] buf, int start, int count) {
- if (count == 0) {
- return;
- }
- if (characters == null) {
- characters = new StringBuffer(count);
- }
- characters.append(buf, start, count);
- }
-
- /** Get the text content of this element. Various text chunks are
- * concatenated, there is no way ( currently ) of keeping track of
- * multiple fragments.
- *
- * @return the text content of this element.
- */
- public StringBuffer getText() {
- if (characters != null) {
- return characters;
- } else {
- return new StringBuffer(0);
- }
- }
-
- /**
- * Returns the tag name of the wrapped element.
- *
- * @return The tag name of the wrapped element. This is unlikely
- * to be <code>null</code>, but may be.
- */
- public String getElementTag() {
- return elementTag;
- }
-
- /**
- * Configures the wrapped element and all its children.
- * The attributes and text for the wrapped element are configured,
- * and then each child is configured and added. Each time the
- * wrapper is configured, the attributes and text for it are
- * reset.
- *
- * If the element has an <code>id</code> attribute, a reference
- * is added to the project as well.
- *
- * @param p The project containing the wrapped element.
- * Must not be <code>null</code>.
- *
- * @exception BuildException if the configuration fails, for instance due
- * to invalid attributes or children, or text being added to
- * an element which doesn't accept it.
- */
- public void maybeConfigure(Project p) throws BuildException {
- maybeConfigure(p, true);
- }
-
- /**
- * Configures the wrapped element. The attributes and text for
- * the wrapped element are configured. Each time the wrapper is
- * configured, the attributes and text for it are reset.
- *
- * If the element has an <code>id</code> attribute, a reference
- * is added to the project as well.
- *
- * @param p The project containing the wrapped element.
- * Must not be <code>null</code>.
- *
- * @param configureChildren Whether to configure child elements as
- * well. if true, child elements will be configured after the
- * wrapped element.
- *
- * @exception BuildException if the configuration fails, for instance due
- * to invalid attributes or children, or text being added to
- * an element which doesn't accept it.
- */
- public void maybeConfigure(Project p, boolean configureChildren)
- throws BuildException {
- String id = null;
-
- if (proxyConfigured) {
- return;
- }
-
- // Configure the object
- Object target = (wrappedObject instanceof TypeAdapter)
- ? ((TypeAdapter) wrappedObject).getProxy() : wrappedObject;
-
- //PropertyHelper ph=PropertyHelper.getPropertyHelper(p);
- IntrospectionHelper ih =
- IntrospectionHelper.getHelper(p, target.getClass());
-
- if (attributeNames != null) {
- for (int i = 0; i < attributeNames.size(); i++) {
- String name = (String) attributeNames.get(i);
- String value = (String) attributeMap.get(name);
-
- // reflect these into the target
- value = p.replaceProperties(value);
- try {
- ih.setAttribute(p, target,
- name.toLowerCase(Locale.US), value);
- } catch (BuildException be) {
- // id attribute must be set externally
- if (!name.equals("id")) {
- throw be;
- }
- }
- }
- id = (String) attributeMap.get("id");
- }
-
- if (characters != null) {
- ProjectHelper.addText(p, wrappedObject, characters.substring(0));
- }
-
- Enumeration e = getChildren();
- while (e.hasMoreElements()) {
- RuntimeConfigurable child
- = (RuntimeConfigurable) e.nextElement();
- if (child.wrappedObject instanceof Task) {
- Task childTask = (Task) child.wrappedObject;
- childTask.setRuntimeConfigurableWrapper(child);
- }
-
- if ((child.creator != null) && configureChildren) {
- child.maybeConfigure(p);
- child.creator.store();
- continue;
- }
- /*
- * backwards compatibility - element names of nested
- * elements have been all lower-case in Ant, except for
- * tasks in TaskContainers.
- *
- * For TaskContainers, we simply skip configuration here.
- */
- String tag = child.getElementTag().toLowerCase(Locale.US);
- if (configureChildren
- && ih.supportsNestedElement(tag)) {
- child.maybeConfigure(p);
- ProjectHelper.storeChild(p, target, child.wrappedObject,
- tag);
- }
- }
-
- if (id != null) {
- p.addReference(id, wrappedObject);
- }
- proxyConfigured = true;
- }
-
- /**
- * Reconfigure the element, even if it has already been configured.
- *
- * @param p the project instance for this configuration.
- */
- public void reconfigure(Project p) {
- proxyConfigured = false;
- maybeConfigure(p);
- }
-
-
- /**
- * Apply presets, attributes and text are set if not currently set.
- * nested elements are prepended.
- *
- * @param r a <code>RuntimeConfigurable</code> value
- */
- public void applyPreSet(RuntimeConfigurable r) {
- // Attributes
- if (r.attributeMap != null) {
- for (Iterator i = r.attributeMap.keySet().iterator(); i.hasNext();) {
- String name = (String) i.next();
- if (attributeMap == null || attributeMap.get(name) == null) {
- setAttribute(name, (String) r.attributeMap.get(name));
- }
- }
- }
- // poly type
- if (r.polyType != null && polyType == null) {
- polyType = r.polyType;
- }
-
- // Children (this is a shadow of unknownElement#children)
- if (r.children != null) {
- List newChildren = new ArrayList();
- newChildren.addAll(r.children);
- if (children != null) {
- newChildren.addAll(children);
- }
- children = newChildren;
- }
-
- // Text
- if (r.characters != null) {
- if (characters == null
- || characters.toString().trim().length() == 0) {
- characters =
- new StringBuffer(r.characters.toString());
- }
- }
- }
- }