ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jsk...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant RuntimeConfigurable.java
Date Fri, 01 Mar 2002 16:29:15 GMT
jskeet      02/03/01 08:29:15

  Modified:    src/main/org/apache/tools/ant RuntimeConfigurable.java
  Log:
  JavaDoc changes.
  
  Revision  Changes    Path
  1.13      +73 -16    jakarta-ant/src/main/org/apache/tools/ant/RuntimeConfigurable.java
  
  Index: RuntimeConfigurable.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/RuntimeConfigurable.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- RuntimeConfigurable.java	10 Jan 2002 11:21:19 -0000	1.12
  +++ RuntimeConfigurable.java	1 Mar 2002 16:29:15 -0000	1.13
  @@ -1,7 +1,7 @@
   /*
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
  + * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -61,81 +61,138 @@
   import org.xml.sax.helpers.AttributeListImpl;
   
   /**
  - * Wrapper class that holds the attributes of a Task (or elements
  - * nested below that level) and takes care of configuring that element
  - * at runtime.
  + * 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();
   
       /**
  -     * @param proxy The element to wrap.
  +     * 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;
       }
   
       /**
  -     * Set's the attributes for the wrapped element.
  +     * 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 AttributeList of the wrapped element.
  +     * 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 child elements to the wrapped element.
  +     * 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 with index <code>index</code>.
  +     * 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);
       }
   
       /**
  -     * Add characters from #PCDATA areas to the wrapped element.
  +     * 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);
       }
   
       /**
  -     * Add characters from #PCDATA areas to the wrapped element.
  -     */
  -    public void addText(char[] buf, int start, int end) {
  -        addText(new String(buf, start, end));
  +     * 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;
       }
   
  -
       /**
  -     * Configure the wrapped element and all children.
  +     * 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;
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message