src/main/org/apache/tools/ant/RuntimeConfigurable.java - ant - Git at Google

 /*
  * The Apache Software License, Version 1.1
  *
  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowlegement:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowlegement may appear in the software itself,
  *    if and wherever such third-party acknowlegements normally appear.
  *
  * 4. The names "The Jakarta Project", "Ant", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
  *    from this software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache"
  *    nor may "Apache" appear in their names without prior written
  *    permission of the Apache Group.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */

 package org.apache.tools.ant;

 import java.util.Enumeration;
 import java.util.Locale;
 import java.util.Vector;
 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.
  *
  * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
  */
 public class RuntimeConfigurable {

     /** Name of the element to configure. */
     private String elementTag = null;
     /** List of child element wrappers. */
     private Vector children = new Vector();
     /** The element to configure. */
     private Object wrappedObject = null;
     /** XML attributes for the element. */
     private AttributeList attributes;
     /** Text appearing within the element. */
     private StringBuffer characters = new StringBuffer();

     /**
      * 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;
     }

     /**
      * Sets the element to configure. This is used when the real type of
      * an element isn't known at the time of wrapper creation.
      *
      * @param proxy The element to configure. Must not be <code>null</code>.
      */
     void setProxy(Object proxy) {
         wrappedObject = proxy;
     }

     /**
      * Sets the attributes for the wrapped element.
      *
      * @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);
     }

     /**
      * Returns the list of attributes for the wrapped element.
      *
      * @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) {
         children.addElement(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.elementAt(index);
     }

     /**
      * 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) {
         characters.append(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) {
         addText(new String(buf, start, count));
     }

     /**
      * 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 {
         String id = null;

         if (attributes != null) {
             ProjectHelper.configure(wrappedObject, attributes, p);
             id = attributes.getValue("id");
             attributes = null;
         }
         if (characters.length() != 0) {
             ProjectHelper.addText(p, wrappedObject, characters.toString());
             characters.setLength(0);
         }
         Enumeration enum = children.elements();
         while (enum.hasMoreElements()) {
             RuntimeConfigurable child = (RuntimeConfigurable) enum.nextElement();
             if (child.wrappedObject instanceof Task) {
                 Task childTask = (Task) child.wrappedObject;
                 childTask.setRuntimeConfigurableWrapper(child);
                 childTask.maybeConfigure();
             } else {
                 child.maybeConfigure(p);
             }
             ProjectHelper.storeChild(p, wrappedObject, child.wrappedObject, child.getElementTag().toLowerCase(Locale.US));
         }

         if (id != null) {
             p.addReference(id, wrappedObject);
         }
     }

 }
	/*
	* The Apache Software License, Version 1.1
	*
	* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution, if
	* any, must include the following acknowlegement:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowlegement may appear in the software itself,
	* if and wherever such third-party acknowlegements normally appear.
	*
	* 4. The names "The Jakarta Project", "Ant", and "Apache Software
	* Foundation" must not be used to endorse or promote products derived
	* from this software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache"
	* nor may "Apache" appear in their names without prior written
	* permission of the Apache Group.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/

	package org.apache.tools.ant;

	import java.util.Enumeration;
	import java.util.Locale;
	import java.util.Vector;
	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.
	*
	* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
	*/
	public class RuntimeConfigurable {

	/** Name of the element to configure. */
	private String elementTag = null;
	/** List of child element wrappers. */
	private Vector children = new Vector();
	/** The element to configure. */
	private Object wrappedObject = null;
	/** XML attributes for the element. */
	private AttributeList attributes;
	/** Text appearing within the element. */
	private StringBuffer characters = new StringBuffer();

	/**
	* 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;
	}

	/**
	* Sets the element to configure. This is used when the real type of
	* an element isn't known at the time of wrapper creation.
	*
	* @param proxy The element to configure. Must not be <code>null</code>.
	*/
	void setProxy(Object proxy) {
	wrappedObject = proxy;
	}

	/**
	* Sets the attributes for the wrapped element.
	*
	* @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);
	}

	/**
	* Returns the list of attributes for the wrapped element.
	*
	* @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) {
	children.addElement(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.elementAt(index);
	}

	/**
	* 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) {
	characters.append(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) {
	addText(new String(buf, start, count));
	}

	/**
	* 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 {
	String id = null;

	if (attributes != null) {
	ProjectHelper.configure(wrappedObject, attributes, p);
	id = attributes.getValue("id");
	attributes = null;
	}
	if (characters.length() != 0) {
	ProjectHelper.addText(p, wrappedObject, characters.toString());
	characters.setLength(0);
	}
	Enumeration enum = children.elements();
	while (enum.hasMoreElements()) {
	RuntimeConfigurable child = (RuntimeConfigurable) enum.nextElement();
	if (child.wrappedObject instanceof Task) {
	Task childTask = (Task) child.wrappedObject;
	childTask.setRuntimeConfigurableWrapper(child);
	childTask.maybeConfigure();
	} else {
	child.maybeConfigure(p);
	}
	ProjectHelper.storeChild(p, wrappedObject, child.wrappedObject, child.getElementTag().toLowerCase(Locale.US));
	}

	if (id != null) {
	p.addReference(id, wrappedObject);
	}
	}

	}