You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by pe...@apache.org on 2005/03/11 12:02:59 UTC
cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Copydir.java Copyfile.java Dirname.java Ear.java Echo.java
peterreilly 2005/03/11 03:02:59
Modified: src/main/org/apache/tools/ant/taskdefs Copydir.java
Copyfile.java Dirname.java Ear.java Echo.java
Log:
javadoc
Revision Changes Path
1.35 +21 -1 ant/src/main/org/apache/tools/ant/taskdefs/Copydir.java
Index: Copydir.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Copydir.java,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- Copydir.java 9 Mar 2004 16:48:04 -0000 1.34
+++ Copydir.java 11 Mar 2005 11:02:59 -0000 1.35
@@ -1,5 +1,5 @@
/*
- * Copyright 2000,2002-2004 The Apache Software Foundation
+ * Copyright 2000,2002-2005 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.
@@ -60,18 +60,38 @@
destDir = dest;
}
+ /**
+ * The filtering attribute.
+ * Default is false.
+ * @param filter if true use filtering
+ */
public void setFiltering(boolean filter) {
filtering = filter;
}
+ /**
+ * The flattening attribute.
+ * Default is false.
+ * @param flatten if true use flattening
+ */
public void setFlatten(boolean flatten) {
this.flatten = flatten;
}
+ /**
+ * The forceoverwrite attribute.
+ * Default is false.
+ * @param force if true overwrite even if the destination file
+ * is newer that the source file
+ */
public void setForceoverwrite(boolean force) {
forceOverwrite = force;
}
+ /**
+ * Execute the task.
+ * @throws BuildException on error
+ */
public void execute() throws BuildException {
log("DEPRECATED - The copydir task is deprecated. Use copy instead.");
1.23 +24 -1 ant/src/main/org/apache/tools/ant/taskdefs/Copyfile.java
Index: Copyfile.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Copyfile.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- Copyfile.java 9 Mar 2004 16:48:04 -0000 1.22
+++ Copyfile.java 11 Mar 2005 11:02:59 -0000 1.23
@@ -1,5 +1,5 @@
/*
- * Copyright 2000,2002,2004 The Apache Software Foundation
+ * Copyright 2000,2002,2004-2005 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.
@@ -39,22 +39,45 @@
private boolean filtering = false;
private boolean forceOverwrite = false;
+ /**
+ * Set the source file.
+ * @param src the source file.
+ */
public void setSrc(File src) {
srcFile = src;
}
+ /**
+ * The forceoverwrite attribute.
+ * Default is false.
+ * @param force if true overwrite even if the destination file
+ * is newer that the source file
+ */
public void setForceoverwrite(boolean force) {
forceOverwrite = force;
}
+ /**
+ * Set the destination file.
+ * @param dest the destination file.
+ */
public void setDest(File dest) {
destFile = dest;
}
+ /**
+ * The filtering attribute.
+ * Default is false.
+ * @param filter if true use filtering
+ */
public void setFiltering(String filter) {
filtering = Project.toBoolean(filter);
}
+ /**
+ * Execute the task.
+ * @throws BuildException on error
+ */
public void execute() throws BuildException {
log("DEPRECATED - The copyfile task is deprecated. Use copy instead.");
1.13 +6 -3 ant/src/main/org/apache/tools/ant/taskdefs/Dirname.java
Index: Dirname.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Dirname.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Dirname.java 9 Mar 2005 00:20:40 -0000 1.12
+++ Dirname.java 11 Mar 2005 11:02:59 -0000 1.13
@@ -48,7 +48,7 @@
/**
* Path to take the dirname of.
- * @param file
+ * @param file a <code>File</code> value
*/
public void setFile(File file) {
this.file = file;
@@ -56,14 +56,17 @@
/**
* The name of the property to set.
- * @param property
+ * @param property the name of the property
*/
public void setProperty(String property) {
this.property = property;
}
- // The method executing the task
+ /**
+ * Execute this task.
+ * @throws BuildException on error
+ */
public void execute() throws BuildException {
if (property == null) {
throw new BuildException("property attribute required", getLocation());
1.31 +14 -1 ant/src/main/org/apache/tools/ant/taskdefs/Ear.java
Index: Ear.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Ear.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- Ear.java 6 Jan 2005 12:05:05 -0000 1.30
+++ Ear.java 11 Mar 2005 11:02:59 -0000 1.31
@@ -37,7 +37,6 @@
private File deploymentDescriptor;
private boolean descriptorAdded;
-
/**
* Create an Ear task.
*/
@@ -48,6 +47,8 @@
}
/**
+ * Set the destination file.
+ * @param earFile the destination file
* @deprecated Use setDestFile(destfile) instead
*/
public void setEarfile(File earFile) {
@@ -56,6 +57,7 @@
/**
* File to incorporate as application.xml.
+ * @param descr the descriptor file
*/
public void setAppxml(File descr) {
deploymentDescriptor = descr;
@@ -86,6 +88,12 @@
}
+ /**
+ * Initialize the output stream.
+ * @param zOut the zip output stream.
+ * @throws IOException on I/O errors
+ * @throws BuildException on other errors
+ */
protected void initZipOutputStream(ZipOutputStream zOut)
throws IOException, BuildException {
// If no webxml file is specified, it's an error.
@@ -98,6 +106,11 @@
/**
* Overridden from Zip class to deal with application.xml
+ * @param file the file to add to the archive
+ * @param zOut the stream to write to
+ * @param vPath the name this entry shall have in the archive
+ * @param mode the Unix permissions to set.
+ * @throws IOException on error
*/
protected void zipFile(File file, ZipOutputStream zOut, String vPath,
int mode)
1.37 +3 -3 ant/src/main/org/apache/tools/ant/taskdefs/Echo.java
Index: Echo.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Echo.java,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- Echo.java 22 Nov 2004 09:23:27 -0000 1.36
+++ Echo.java 11 Mar 2005 11:02:59 -0000 1.37
@@ -1,5 +1,5 @@
/*
- * Copyright 2000-2004 The Apache Software Foundation
+ * Copyright 2000-2005 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.
@@ -134,7 +134,7 @@
/**
* mapping of enumerated values to log levels
*/
- private static int levels[] = {
+ private static int[] levels = {
Project.MSG_ERR,
Project.MSG_WARN,
Project.MSG_INFO,
@@ -144,7 +144,7 @@
/**
* get the level of the echo of the current value
- * @return
+ * @return the level
*/
public int getLevel() {
return levels[getIndex()];
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org