Save This Page
Home » apache-ant-1.7.1-src » org.apache.tools » ant » [javadoc | source]
org.apache.tools.ant
public class: RuntimeConfigurable [javadoc | source]
java.lang.Object
   org.apache.tools.ant.RuntimeConfigurable

All Implemented Interfaces:
    Serializable

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.
Constructor:
 public RuntimeConfigurable(Object proxy,
    String elementTag) 
    Sole constructor creating a wrapper for the specified object.
    Parameters:
    proxy - The element to configure. Must not be null.
    elementTag - The tag name generating this element.
Method from org.apache.tools.ant.RuntimeConfigurable Summary:
addChild,   addText,   addText,   applyPreSet,   getAttributeMap,   getAttributes,   getChild,   getChildren,   getElementTag,   getId,   getPolyType,   getProxy,   getText,   maybeConfigure,   maybeConfigure,   reconfigure,   removeAttribute,   setAttribute,   setAttributes,   setCreator,   setElementTag,   setPolyType,   setProxy
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.ant.RuntimeConfigurable Detail:
 public synchronized  void addChild(RuntimeConfigurable child) 
    Adds a child element to the wrapped element.
 public synchronized  void addText(String data) 
    Adds characters from #PCDATA areas to the wrapped element.
 public synchronized  void addText(char[] buf,
    int start,
    int count) 
    Adds characters from #PCDATA areas to the wrapped element.
 public  void applyPreSet(RuntimeConfigurable r) 
    Apply presets, attributes and text are set if not currently set. Nested elements are prepended.
 public synchronized Hashtable getAttributeMap() 
    Return the attribute map.
 public synchronized AttributeList getAttributes() 
Deprecated! Deprecated - since Ant 1.6 in favor of #getAttributeMap .

    Returns the list of attributes for the wrapped element.
 synchronized RuntimeConfigurable getChild(int index) 
    Returns the child wrapper at the specified position within the list.
 public synchronized Enumeration getChildren() 
    Returns an enumeration of all child wrappers.
 public synchronized String getElementTag() 
    Returns the tag name of the wrapped element.
 public synchronized String getId() 
    Returns the id for this element.
 public synchronized String getPolyType() 
    Get the polymorphic type for this element.
 public synchronized Object getProxy() 
    Get the object for which this RuntimeConfigurable holds the configuration information.
 public synchronized StringBuffer getText() 
    Get the text content of this element. Various text chunks are concatenated, there is no way ( currently ) of keeping track of multiple fragments.
 public  void maybeConfigure(Project p) throws BuildException 
    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 id attribute, a reference is added to the project as well.
 public synchronized  void maybeConfigure(Project p,
    boolean configureChildren) throws BuildException 
    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 id attribute, a reference is added to the project as well.
 public  void reconfigure(Project p) 
    Reconfigure the element, even if it has already been configured.
 public synchronized  void removeAttribute(String name) 
    Delete an attribute. Not for the faint of heart.
 public synchronized  void setAttribute(String name,
    String value) 
    Set an attribute to a given value.
 public synchronized  void setAttributes(AttributeList attributes) 
Deprecated! since - 1.6.x.

    Sets the attributes for the wrapped element.
 synchronized  void setCreator(IntrospectionHelper.Creator creator) 
    Sets the creator of the element to be configured used to store the element in the parent.
 public synchronized  void setElementTag(String elementTag) 
    Set the element tag.
 public synchronized  void setPolyType(String polyType) 
    Set the polymorphic type for this element.
 public synchronized  void setProxy(Object proxy) 
    Sets the element to configure.