You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by mb...@apache.org on 2004/12/14 22:18:08 UTC
cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Ant.java CallTarget.java
mbenson 2004/12/14 13:18:08
Modified: src/main/org/apache/tools/ant/taskdefs Ant.java
CallTarget.java
Log:
Javadoc
Revision Changes Path
1.110 +31 -50 ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
Index: Ant.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
retrieving revision 1.109
retrieving revision 1.110
diff -u -r1.109 -r1.110
--- Ant.java 7 Dec 2004 06:44:34 -0000 1.109
+++ Ant.java 14 Dec 2004 21:18:08 -0000 1.110
@@ -203,9 +203,8 @@
}
/**
- * Pass output sent to System.out to the new project.
+ * @see Task#handleOutput(String)
*
- * @param output a line of output
* @since Ant 1.5
*/
public void handleOutput(String output) {
@@ -217,16 +216,6 @@
}
/**
- * Process input into the ant task
- *
- * @param buffer the buffer into which data is to be read.
- * @param offset the offset into the buffer at which data is stored.
- * @param length the amount of data to read
- *
- * @return the number of bytes read
- *
- * @exception IOException if the data cannot be read
- *
* @see Task#handleInput(byte[], int, int)
*
* @since Ant 1.6
@@ -241,9 +230,7 @@
}
/**
- * Pass output sent to System.out to the new project.
- *
- * @param output The output to log. Should not be <code>null</code>.
+ * @see Task#handleFlush(String)
*
* @since Ant 1.5.2
*/
@@ -256,9 +243,7 @@
}
/**
- * Pass output sent to System.err to the new project.
- *
- * @param output The error output to log. Should not be <code>null</code>.
+ * @see Task#handleErrorOutput(String)
*
* @since Ant 1.5
*/
@@ -271,9 +256,7 @@
}
/**
- * Pass output sent to System.err to the new project.
- *
- * @param output The error output to log. Should not be <code>null</code>.
+ * @see Task#handleErrorFlush(String)
*
* @since Ant 1.5.2
*/
@@ -287,8 +270,8 @@
/**
* Do the execution.
- * @throws BuildException if a target tries to call itself
- * probably also if a BuildException is thrown by the new project
+ * @throws BuildException if a target tries to call itself;
+ * probably also if a BuildException is thrown by the new project.
*/
public void execute() throws BuildException {
File savedDir = dir;
@@ -435,7 +418,7 @@
/**
* Override the properties in the new project with the one
* explicitly defined as nested elements here.
- * @throws BuildException under unknown circumstances
+ * @throws BuildException under unknown circumstances.
*/
private void overrideProperties() throws BuildException {
// remove duplicate properties - last property wins
@@ -465,7 +448,7 @@
* new project. Also copy over all references that don't override
* existing references in the new project if inheritrefs has been
* requested.
- * @throws BuildException if a reference does not have a refid
+ * @throws BuildException if a reference does not have a refid.
*/
private void addReferences() throws BuildException {
Hashtable thisReferences
@@ -511,11 +494,12 @@
/**
* Try to clone and reconfigure the object referenced by oldkey in
- * the parent project and add it to the new project with the key
- * newkey.
+ * the parent project and add it to the new project with the key newkey.
*
* <p>If we cannot clone it, copy the referenced object itself and
* keep our fingers crossed.</p>
+ * @param oldKey the reference id in the current project.
+ * @param newKey the reference id in the new project.
*/
private void copyReference(String oldKey, String newKey) {
Object orig = getProject().getReference(oldKey);
@@ -564,7 +548,7 @@
* Copies all properties from the given table to the new project -
* omitting those that have already been set in the new project as
* well as properties named basedir or ant.file.
- * @param props properties to copy to the new project
+ * @param props properties <code>Hashtable</code> to copy to the new project.
* @since Ant 1.6
*/
private void addAlmostAll(Hashtable props) {
@@ -590,17 +574,16 @@
* Defaults to the current project's basedir, unless inheritall
* has been set to false, in which case it doesn't have a default
* value. This will override the basedir setting of the called project.
- * @param d new directory
+ * @param d new directory as <code>File</code>.
*/
public void setDir(File d) {
this.dir = d;
}
/**
- * The build file to use.
- * Defaults to "build.xml". This file is expected to be a filename relative
- * to the dir attribute given.
- * @param s build file to use
+ * The build file to use. Defaults to "build.xml". This file is expected
+ * to be a filename relative to the dir attribute given.
+ * @param s the <code>String</code> build file name.
*/
public void setAntfile(String s) {
// @note: it is a string and not a file to handle relative/absolute
@@ -612,23 +595,21 @@
/**
* The target of the new Ant project to execute.
* Defaults to the new project's default target.
- * @param s target to invoke
+ * @param s the name of the target to invoke.
*/
public void setTarget(String s) {
if (s.equals("")) {
throw new BuildException("target attribute must not be empty");
}
-
targets.add(s);
targetAttributeSet = true;
}
/**
- * Filename to write the output to.
- * This is relative to the value of the dir attribute
- * if it has been set or to the base directory of the
+ * Set the filename to write the output to. This is relative to the value
+ * of the dir attribute if it has been set or to the base directory of the
* current project otherwise.
- * @param s file to which the output should go to
+ * @param s the name of the file to which the output should go.
*/
public void setOutput(String s) {
this.output = s;
@@ -636,8 +617,8 @@
/**
* Property to pass to the new project.
- * The property is passed as a 'user property'
- * @return new property created
+ * The property is passed as a 'user property'.
+ * @return the created <code>Property</code> object.
*/
public Property createProperty() {
if (newProject == null) {
@@ -651,9 +632,9 @@
}
/**
- * Reference element identifying a data type to carry
+ * Add a Reference element identifying a data type to carry
* over to the new project.
- * @param r reference to add
+ * @param r <code>Reference</code> to add.
*/
public void addReference(Reference r) {
references.addElement(r);
@@ -662,7 +643,7 @@
/**
* Add a target to this Ant invocation.
* @param t the <CODE>TargetElement</CODE> to add.
- * @since Ant 1.7
+ * @since Ant 1.6.3
*/
public void addConfiguredTarget(TargetElement t) {
if (targetAttributeSet) {
@@ -677,9 +658,9 @@
}
/**
- * Set of properties to pass to the new project.
+ * Add a set of properties to pass to the new project.
*
- * @param ps property set to add
+ * @param ps <code>PropertySet</code> to add.
* @since Ant 1.6
*/
public void addPropertyset(PropertySet ps) {
@@ -700,7 +681,7 @@
public static class Reference
extends org.apache.tools.ant.types.Reference {
- /** Creates a reference to be configured by Ant */
+ /** Creates a reference to be configured by Ant. */
public Reference() {
super();
}
@@ -712,14 +693,14 @@
* new project.
*
* @param targetid the id under which this reference will be passed to
- * the new project */
+ * the new project. */
public void setToRefid(String targetid) {
this.targetid = targetid;
}
/**
* Get the id under which this reference will be stored in the new
- * project
+ * project.
*
* @return the id of the reference in the new project.
*/
@@ -731,7 +712,7 @@
/**
* Helper class that implements the nested <target>
* element of <ant> and <antcall>.
- * @since Ant 1.7
+ * @since Ant 1.6.3
*/
public static class TargetElement {
private String name;
1.42 +25 -21 ant/src/main/org/apache/tools/ant/taskdefs/CallTarget.java
Index: CallTarget.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/CallTarget.java,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- CallTarget.java 24 Jun 2004 19:30:03 -0000 1.41
+++ CallTarget.java 14 Dec 2004 21:18:08 -0000 1.42
@@ -17,10 +17,12 @@
package org.apache.tools.ant.taskdefs;
-import org.apache.tools.ant.BuildException;
-import org.apache.tools.ant.Task;
import java.io.IOException;
+import org.apache.tools.ant.Task;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.types.PropertySet;
+
/**
* Call another target in the same project.
*
@@ -58,6 +60,7 @@
/**
* If true, pass all properties to the new Ant project.
* Defaults to true.
+ * @param inherit <code>boolean</code> flag.
*/
public void setInheritAll(boolean inherit) {
inheritAll = inherit;
@@ -65,16 +68,16 @@
/**
* If true, pass all references to the new Ant project.
- * Defaults to false
- * @param inheritRefs new value
+ * Defaults to false.
+ * @param inheritRefs <code>boolean</code> flag.
*/
public void setInheritRefs(boolean inheritRefs) {
this.inheritRefs = inheritRefs;
}
/**
- * init this task by creating new instance of the ant task and
- * configuring it's by calling its own init method.
+ * Initialize this task by creating new instance of the ant task and
+ * configuring it by calling its own init method.
*/
public void init() {
callee = (Ant) getProject().createTask("ant");
@@ -85,21 +88,19 @@
}
/**
- * hand off the work to the ant task of ours, after setting it up
+ * Delegate the work to the ant task instance, after setting it up.
* @throws BuildException on validation failure or if the target didn't
- * execute
+ * execute.
*/
public void execute() throws BuildException {
if (callee == null) {
init();
}
-
if (!targetSet) {
throw new BuildException(
"Attribute target or at least one nested target is required.",
getLocation());
}
-
callee.setAntfile(getProject().getProperty("ant.file"));
callee.setInheritAll(inheritAll);
callee.setInheritRefs(inheritRefs);
@@ -107,7 +108,8 @@
}
/**
- * Property to pass to the invoked target.
+ * Create a new Property to pass to the invoked target(s).
+ * @return a <code>Property</code> object.
*/
public Property createParam() {
if (callee == null) {
@@ -119,6 +121,7 @@
/**
* Reference element identifying a data type to carry
* over to the invoked target.
+ * @param r the specified <code>Ant.Reference</code>.
* @since Ant 1.5
*/
public void addReference(Ant.Reference r) {
@@ -130,10 +133,10 @@
/**
* Set of properties to pass to the new project.
- *
+ * @param ps the <code>PropertySet</code> to pass.
* @since Ant 1.6
*/
- public void addPropertyset(org.apache.tools.ant.types.PropertySet ps) {
+ public void addPropertyset(PropertySet ps) {
if (callee == null) {
init();
}
@@ -141,7 +144,8 @@
}
/**
- * Target to execute, required.
+ * Set target to execute.
+ * @param target the name of the target to execute.
*/
public void setTarget(String target) {
if (callee == null) {
@@ -152,9 +156,9 @@
}
/**
- * Target element identifying a data type to carry
- * over to the invoked target.
- * @since Ant 1.6.2
+ * Add a target to the list of targets to invoke.
+ * @param t <code>Ant.TargetElement</code> representing the target.
+ * @since Ant 1.6.3
*/
public void addConfiguredTarget(Ant.TargetElement t) {
if (callee == null) {
@@ -165,7 +169,7 @@
}
/**
- * Pass output sent to System.out to the new project.
+ * @see Task#handleOutput(String)
*
* @since Ant 1.5
*/
@@ -192,7 +196,7 @@
}
/**
- * Pass output sent to System.out to the new project.
+ * @see Task#handleFlush(String)
*
* @since Ant 1.5.2
*/
@@ -205,7 +209,7 @@
}
/**
- * Pass output sent to System.err to the new project.
+ * @see Task#handleErrorOutput(String)
*
* @since Ant 1.5
*/
@@ -218,7 +222,7 @@
}
/**
- * Pass output sent to System.err to the new project and flush stream.
+ * @see Task#handleErrorFlush(String)
*
* @since Ant 1.5.2
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Ant.java CallTarget.java
Posted by Matt Benson <gu...@yahoo.com>.
--- Matt Benson <gu...@yahoo.com> wrote:
> I rarely document overridden methods myself, but I
> will admit that I may have accidentally deleted
> information detailing how the subclass
> implementation
> differs or elaborates substantially upon the base
> implementation. I will go back today and take a
> second look at what I deleted.
I don't see that what I removed contained any really
earth-shattering information. :) But if you are more
comfortable I can revert the changes.
-Matt
>
> --- Peter Reilly <pe...@apache.org> wrote:
>
> >
> > Hi Matt,
> > the following changes remove information
> > from the javadoc.
> >
> > Peter
> >
[SNIP]
__________________________________
Do you Yahoo!?
Send holiday email and support a worthy cause. Do good.
http://celebrity.mail.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Ant.java CallTarget.java
Posted by Matt Benson <gu...@yahoo.com>.
I rarely document overridden methods myself, but I
will admit that I may have accidentally deleted
information detailing how the subclass implementation
differs or elaborates substantially upon the base
implementation. I will go back today and take a
second look at what I deleted.
--- Peter Reilly <pe...@apache.org> wrote:
>
> Hi Matt,
> the following changes remove information
> from the javadoc.
>
> Peter
>
> mbenson@apache.org wrote:
>
> >mbenson 2004/12/14 13:18:08
> >
> > Modified:
> src/main/org/apache/tools/ant/taskdefs Ant.java
> > CallTarget.java
> > Log:
> > Javadoc
> >
> > Revision Changes Path
> > 1.110 +31 -50
> ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
> >
> > Index: Ant.java
> >
>
===================================================================
> > RCS file:
>
/home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
> > retrieving revision 1.109
> > retrieving revision 1.110
> > diff -u -r1.109 -r1.110
> > --- Ant.java 7 Dec 2004 06:44:34 -0000 1.109
> > +++ Ant.java 14 Dec 2004 21:18:08 -0000 1.110
> > @@ -203,9 +203,8 @@
> > }
> >
> > /**
> > - * Pass output sent to System.out to the new
> project.
> > + * @see Task#handleOutput(String)
> > *
> > - * @param output a line of output
> > * @since Ant 1.5
> > */
> > public void handleOutput(String output) {
> > @@ -217,16 +216,6 @@
> > }
> > * @since Ant 1.6
> > @@ -241,9 +230,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.out to the new
> project.
> > - *
> > - * @param output The output to log. Should
> not be <code>null</code>.
> > + * @see Task#handleFlush(String)
> > *
> > * @since Ant 1.5.2
> > */
> > @@ -256,9 +243,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.err to the new
> project.
> > - *
> > - * @param output The error output to log.
> Should not be <code>null</code>.
> > + * @see Task#handleErrorOutput(String)
> > *
> > * @since Ant 1.5
> > */
> > @@ -271,9 +256,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.err to the new
> project.
> > - *
> > - * @param output The error output to log.
> Should not be <code>null</code>.
> > + * @see Task#handleErrorFlush(String)
> > *
> > * @since Ant 1.5.2
> > */
> >
> >
>
> >
> > /**
> > - * Pass output sent to System.out to the new
> project.
> > + * @see Task#handleOutput(String)
> > *
> > * @since Ant 1.5
> > */
> > @@ -192,7 +196,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.out to the new
> project.
> > + * @see Task#handleFlush(String)
> > *
> > * @since Ant 1.5.2
> > */
> > @@ -205,7 +209,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.err to the new
> project.
> > + * @see Task#handleErrorOutput(String)
> > *
> > * @since Ant 1.5
> > */
> > @@ -218,7 +222,7 @@
> > }
> >
> > /**
> > - * Pass output sent to System.err to the new
> project and flush stream.
> > + * @see Task#handleErrorFlush(String)
> > *
> > * @since Ant 1.5.2
> > */
> >
> >
> >
> >
>
>---------------------------------------------------------------------
> >To unsubscribe, e-mail:
> dev-unsubscribe@ant.apache.org
> >For additional commands, e-mail:
> dev-help@ant.apache.org
> >
> >
> >
> >
> >
>
>
>
---------------------------------------------------------------------
> To unsubscribe, e-mail:
> dev-unsubscribe@ant.apache.org
> For additional commands, e-mail:
> dev-help@ant.apache.org
>
>
__________________________________
Do you Yahoo!?
Dress up your holiday email, Hollywood style. Learn more.
http://celebrity.mail.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Ant.java
CallTarget.java
Posted by Peter Reilly <pe...@apache.org>.
Hi Matt,
the following changes remove information
from the javadoc.
Peter
mbenson@apache.org wrote:
>mbenson 2004/12/14 13:18:08
>
> Modified: src/main/org/apache/tools/ant/taskdefs Ant.java
> CallTarget.java
> Log:
> Javadoc
>
> Revision Changes Path
> 1.110 +31 -50 ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
>
> Index: Ant.java
> ===================================================================
> RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
> retrieving revision 1.109
> retrieving revision 1.110
> diff -u -r1.109 -r1.110
> --- Ant.java 7 Dec 2004 06:44:34 -0000 1.109
> +++ Ant.java 14 Dec 2004 21:18:08 -0000 1.110
> @@ -203,9 +203,8 @@
> }
>
> /**
> - * Pass output sent to System.out to the new project.
> + * @see Task#handleOutput(String)
> *
> - * @param output a line of output
> * @since Ant 1.5
> */
> public void handleOutput(String output) {
> @@ -217,16 +216,6 @@
> }
> * @since Ant 1.6
> @@ -241,9 +230,7 @@
> }
>
> /**
> - * Pass output sent to System.out to the new project.
> - *
> - * @param output The output to log. Should not be <code>null</code>.
> + * @see Task#handleFlush(String)
> *
> * @since Ant 1.5.2
> */
> @@ -256,9 +243,7 @@
> }
>
> /**
> - * Pass output sent to System.err to the new project.
> - *
> - * @param output The error output to log. Should not be <code>null</code>.
> + * @see Task#handleErrorOutput(String)
> *
> * @since Ant 1.5
> */
> @@ -271,9 +256,7 @@
> }
>
> /**
> - * Pass output sent to System.err to the new project.
> - *
> - * @param output The error output to log. Should not be <code>null</code>.
> + * @see Task#handleErrorFlush(String)
> *
> * @since Ant 1.5.2
> */
>
>
>
> /**
> - * Pass output sent to System.out to the new project.
> + * @see Task#handleOutput(String)
> *
> * @since Ant 1.5
> */
> @@ -192,7 +196,7 @@
> }
>
> /**
> - * Pass output sent to System.out to the new project.
> + * @see Task#handleFlush(String)
> *
> * @since Ant 1.5.2
> */
> @@ -205,7 +209,7 @@
> }
>
> /**
> - * Pass output sent to System.err to the new project.
> + * @see Task#handleErrorOutput(String)
> *
> * @since Ant 1.5
> */
> @@ -218,7 +222,7 @@
> }
>
> /**
> - * Pass output sent to System.err to the new project and flush stream.
> + * @see Task#handleErrorFlush(String)
> *
> * @since Ant 1.5.2
> */
>
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
>For additional commands, e-mail: dev-help@ant.apache.org
>
>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org