diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
index 5f7683944..1b5909bee 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
@@ -214,6 +214,7 @@ public class Rpm extends Task {
/**
* What command to issue to the rpm build tool; optional.
* The default is "-bb"
+ * @param c the command to use.
*/
public void setCommand(String c) {
this.command = c;
@@ -221,6 +222,7 @@ public class Rpm extends Task {
/**
* The name of the spec File to use; required.
+ * @param sf the spec file name to use.
*/
public void setSpecFile(String sf) {
if ((sf == null) || (sf.trim().equals(""))) {
@@ -232,6 +234,7 @@ public class Rpm extends Task {
/**
* Flag (optional, default=false) to remove
* the generated files in the BUILD directory
+ * @param cbd a boolean value.
*/
public void setCleanBuildDir(boolean cbd) {
cleanBuildDir = cbd;
@@ -239,6 +242,7 @@ public class Rpm extends Task {
/**
* Flag (optional, default=false) to remove the spec file from SPECS
+ * @param rs a boolean value.
*/
public void setRemoveSpec(boolean rs) {
removeSpec = rs;
@@ -248,6 +252,7 @@ public class Rpm extends Task {
* Flag (optional, default=false)
* to remove the sources after the build.
* See the --rmsource option of rpmbuild.
+ * @param rs a boolean value.
*/
public void setRemoveSource(boolean rs) {
removeSource = rs;
@@ -255,6 +260,7 @@ public class Rpm extends Task {
/**
* Optional file to save stdout to.
+ * @param output the file to save stdout to.
*/
public void setOutput(File output) {
this.output = output;
@@ -262,6 +268,7 @@ public class Rpm extends Task {
/**
* Optional file to save stderr to
+ * @param error the file to save error output to.
*/
public void setError(File error) {
this.error = error;
@@ -338,6 +345,10 @@ public class Rpm extends Task {
}
/**
+ * Get the execute object.
+ * @param toExecute the command line to use.
+ * @param streamhandler the stream handler to use.
+ * @return the execute object.
* @since Ant 1.6.3
*/
protected Execute getExecute(Commandline toExecute,
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java b/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
index 84e6ff6e5..cd4e6ed37 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
@@ -34,10 +34,14 @@ import org.apache.tools.ant.taskdefs.Java;
* This task is considered unsupported by the Ant developers
*/
public class StyleBook extends Java {
+ // CheckStyle:VisibilityModifier OFF - bc
+ // CheckStyle:MemberNameCheck OFF - bc
protected File m_targetDirectory;
protected File m_skinDirectory;
protected String m_loaderConfig;
protected File m_book;
+ // CheckStyle:MemberNameCheck ON
+ // CheckStyle:VisibilityModifier ON
/**
@@ -81,7 +85,7 @@ public class StyleBook extends Java {
/**
* A loader configuration to send to stylebook; optional.
- * @param loaderConfig
+ * @param loaderConfig the configuration to use.
*/
public void setLoaderConfig(final String loaderConfig) {
m_loaderConfig = loaderConfig;
@@ -90,6 +94,7 @@ public class StyleBook extends Java {
/**
* call the program
+ * @throws BuildException if there is a problem.
*/
public void execute()
throws BuildException {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
index f68e790b7..962ba7524 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
@@ -215,7 +215,9 @@ public class XMLValidateTask extends Task {
* Add an attribute nested element. This is used for setting arbitrary
* features of the SAX parser.
* Valid attributes
- * include
+ * include
* @return attribute created
* @since ant1.6
*/
@@ -653,7 +655,9 @@ public class XMLValidateTask extends Task {
public static class Attribute {
/** The name of the attribute to set.
*
- * Valid attributes include.
+ * Valid attributes include.
*/
private String attributeName = null;
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java
index d1f6b4c80..a27983579 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java
@@ -39,8 +39,12 @@ public class CCMCheck extends Continuus {
private String comment = null;
private String task = null;
+ // CheckStyle:VisibilityModifier OFF - bc
+
protected Vector filesets = new Vector();
+ // CheckStyle:VisibilityModifier ON
+
/** Constructor for CCMCheck. */
public CCMCheck() {
super();
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
index 9cb08e4ba..cb6a1ba17 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
@@ -398,12 +398,17 @@ public class Depend extends MatchingTask {
int classMarker = jarFilePath.indexOf('!');
jarFilePath = jarFilePath.substring(0, classMarker);
if (jarFilePath.startsWith("file:")) {
- classpathFileObject = new File(FileUtils.getFileUtils().fromURI(jarFilePath));
+ classpathFileObject = new File(
+ FileUtils.getFileUtils().fromURI(jarFilePath));
} else {
- throw new IOException("Bizarre nested path in jar: protocol: " + jarFilePath);
+ throw new IOException(
+ "Bizarre nested path in jar: protocol: "
+ + jarFilePath);
}
} else if (classURL.getProtocol().equals("file")) {
- classpathFileObject = new File(FileUtils.getFileUtils().fromURI(classURL.toExternalForm()));
+ classpathFileObject = new File(
+ FileUtils.getFileUtils()
+ .fromURI(classURL.toExternalForm()));
}
log("Class " + className
+ " depends on " + classpathFileObject
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java
index 54a8cceeb..66e39729a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java
@@ -385,7 +385,13 @@ public class CSharp extends DotnetCompile {
return "cs";
}
- protected void createResourceParameter(NetCommand command, DotnetResource resource) {
+ /**
+ * Build a C# style parameter.
+ * @param command the command.
+ * @param resource the resource.
+ */
+ protected void createResourceParameter(
+ NetCommand command, DotnetResource resource) {
resource.getParameters(getProject(), command, true);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java
index 9bea82bcf..4d5774fc0 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java
@@ -885,12 +885,10 @@ public abstract class DotnetCompile
}
}
- /* XXX Javadoc makes little sense, rewrite
- * from a resource, get the
- * @param command
- * @param resource
- * @return a string containing the resource param, or a null string
- * to conditionally exclude a resource.
+ /**
+ * Build a C# style parameter.
+ * @param command the command.
+ * @param resource the resource.
*/
protected abstract void createResourceParameter(NetCommand command, DotnetResource resource);
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java
index 6343ad1dc..6053a615a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java
@@ -34,8 +34,9 @@ import org.apache.tools.ant.BuildException;
* nested <src> elements instead of the basedir
* attribute if you need more control.
*
- * @see
- * Visual J++ online documentation
+ * @see Visual J++ online documentation
*
* @since ant1.6
* @ant.task category="dotnet" name="jsharpc"
@@ -121,6 +122,7 @@ public class JSharp extends DotnetCompile {
}
}
+ /** {@inheritDoc} */
protected void createResourceParameter(NetCommand command, DotnetResource resource) {
resource.getParameters(getProject(), command, true);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java
index 6c9a5d632..08636ba15 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java
@@ -373,8 +373,8 @@ public class NetCommand {
/**
* scan through one fileset for files to include
- * @param scanner
- * @param filesToBuild
+ * @param scanner the directory scanner to use.
+ * @param filesToBuild the map to place the files.
* @param outputTimestamp timestamp to compare against
* @return #of files out of date
* @todo should FAT granularity be included here?
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java
index 6fd45b6c7..fe22e377e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java
@@ -347,6 +347,7 @@ public class VisualBasicCompile extends DotnetCompile {
return "vb";
}
+ /** {@inheritDoc} */
protected void createResourceParameter(NetCommand command, DotnetResource resource) {
resource.getParameters(getProject(), command, false);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java
index 78698f5e5..419c3a599 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java
@@ -619,7 +619,7 @@ public final class Extension {
* @param onToken the token
* @return the resultant array
*/
- private static final String[] split(final String string,
+ private static String[] split(final String string,
final String onToken) {
final StringTokenizer tokenizer = new StringTokenizer(string, onToken);
final String[] result = new String[ tokenizer.countTokens() ];
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java
index 47db6ef3c..0f00b557e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java
@@ -217,6 +217,8 @@ public class ExtensionAdapter extends DataType {
}
/**
+ * a debug toString method.
+ * @return the extension in a string.
* @see java.lang.Object#toString()
*/
public String toString() {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java
index b178ceb41..069f095fa 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java
@@ -117,6 +117,7 @@ public class ExtensionSet
/**
* @see java.lang.Object#toString()
+ * @return the extensions in a string.
*/
public String toString() {
return "ExtensionSet" + Arrays.asList(toExtensions(getProject()));
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java
index 1971d9a3a..3a25e6162 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java
@@ -123,12 +123,17 @@ public class GenericHotDeploymentTool extends AbstractHotDeploymentTool {
}
/**
- *
+ * get the java attribute.
+ * @return the java attribute.
*/
public Java getJava() {
return java;
}
+ /**
+ * Get the classname attribute.
+ * @return the classname value.
+ */
public String getClassName() {
return className;
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java
index f67f33366..16c55d8e7 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java
@@ -27,35 +27,35 @@ import org.apache.tools.ant.BuildException;
*/
public interface HotDeploymentTool {
/** The delete action String **/
- public static final String ACTION_DELETE = "delete";
+ String ACTION_DELETE = "delete";
/** The deploy action String **/
- public static final String ACTION_DEPLOY = "deploy";
+ String ACTION_DEPLOY = "deploy";
/** The list action String **/
- public static final String ACTION_LIST = "list";
+ String ACTION_LIST = "list";
/** The undeploy action String **/
- public static final String ACTION_UNDEPLOY = "undeploy";
+ String ACTION_UNDEPLOY = "undeploy";
/** The update action String **/
- public static final String ACTION_UPDATE = "update";
+ String ACTION_UPDATE = "update";
/**
* Validates the passed in attributes.
* @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
*/
- public void validateAttributes() throws BuildException;
+ void validateAttributes() throws BuildException;
/**
* Perform the actual deployment.
* @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
*/
- public void deploy() throws BuildException;
+ void deploy() throws BuildException;
/**
* Sets the parent task.
* @param task A ServerDeploy object representing the parent task.
*/
- public void setTask(ServerDeploy task);
+ void setTask(ServerDeploy task);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
index 4321216ab..c495e3b07 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
@@ -114,6 +114,7 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
* Builds the arguments to pass to weblogic.deploy according to the
* supplied action.
* @return A String containing the arguments for the weblogic.deploy tool.
+ * @throws BuildException if there is an error.
*/
public String getArguments() throws BuildException {
String action = getTask().getAction();
@@ -121,11 +122,9 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
if (action.equals(ACTION_DEPLOY) || action.equals(ACTION_UPDATE)) {
args = buildDeployArgs();
- }
- else if (action.equals(ACTION_DELETE) || action.equals(ACTION_UNDEPLOY)) {
+ } else if (action.equals(ACTION_DELETE) || action.equals(ACTION_UNDEPLOY)) {
args = buildUndeployArgs();
- }
- else if (action.equals(ACTION_LIST)) {
+ } else if (action.equals(ACTION_LIST)) {
args = buildListArgs();
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java b/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java
index ad2ba89b3..121fa4299 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java
@@ -13,6 +13,7 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.apache.tools.ant.taskdefs.optional.javah;
@@ -28,8 +29,10 @@ import org.apache.tools.ant.taskdefs.optional.Javah;
public interface JavahAdapter {
/**
* Performs the actual compilation.
- *
+ * @param javah the calling javah task.
+ * @return true if the compilation was successful.
+ * @throws BuildException if there is an error.
* @since Ant 1.6.3
*/
boolean compile(Javah javah) throws BuildException;
-}
\ No newline at end of file
+}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java b/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java
index 70bac8552..a63e39291 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java
@@ -52,6 +52,7 @@ public class JavahAdapterFactory {
* @param log a ProjectComponent instance used to access Ant's
* logging system.
* @return The adapter to use.
+ * @throws BuildException if there is an error.
*/
public static JavahAdapter getAdapter(String choice,
ProjectComponent log)
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java b/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java
index 0590aff33..d37f77175 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java
@@ -31,11 +31,14 @@ import org.apache.tools.ant.util.JavaEnvUtils;
*/
public class Kaffeh implements JavahAdapter {
+ /** the name of the javah adapter - kaffeh */
public static final String IMPLEMENTATION_NAME = "kaffeh";
/**
* Performs the actual compilation.
- *
+ * @param javah the calling javah task.
+ * @return true if the compilation was successful.
+ * @throws BuildException if there is an error.
* @since Ant 1.6.3
*/
public boolean compile(Javah javah) throws BuildException {
@@ -88,4 +91,4 @@ public class Kaffeh implements JavahAdapter {
return cmd;
}
-}
\ No newline at end of file
+}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java b/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java
index 45be9b672..0b1655ad8 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java
@@ -34,11 +34,14 @@ import org.apache.tools.ant.types.Path;
*/
public class SunJavah implements JavahAdapter {
+ /** the name of the javah adapter - sun */
public static final String IMPLEMENTATION_NAME = "sun";
/**
* Performs the actual compilation.
- *
+ * @param javah the calling javah task.
+ * @return true if the compilation was successful.
+ * @throws BuildException if there is an error.
* @since Ant 1.6.3
*/
public boolean compile(Javah javah) throws BuildException {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java
index 5f371c5cd..3fca458b5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java
@@ -29,7 +29,7 @@ import java.io.InputStream;
* strings from a class file.
*/
class ConstantPool {
-
+ // CheckStyle:VisibilityModifier OFF - bc
static final
byte UTF8 = 1, UNUSED = 2, INTEGER = 3, FLOAT = 4, LONG = 5, DOUBLE = 6,
CLASS = 7, STRING = 8, FIELDREF = 9, METHODREF = 10,
@@ -38,7 +38,13 @@ class ConstantPool {
byte[] types;
Object[] values;
+ // CheckStyle:VisibilityModifier ON
+ /**
+ * Create a constant pool.
+ * @param data the data input containing the class.
+ * @throws IOException if there is an error.
+ */
ConstantPool(DataInput data) throws IOException {
super();
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java
index 78eeffbb8..966146859 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java
@@ -37,6 +37,7 @@ import java.util.zip.ZipException;
import java.util.zip.ZipFile;
import java.util.zip.ZipOutputStream;
+// CheckStyle:TypeNameCheck OFF - bc
/**
* jlink links together multiple .jar files.
*/
@@ -51,8 +52,12 @@ public class jlink {
private boolean compression = false;
+ // CheckStyle:VisibilityModifier OFF - bc
+
byte[] buffer = new byte[8192];
+ // CheckStyle:VisibilityModifier OFF - bc
+
/** The file that will be created by this instance of jlink.
* @param outfile the file to create.
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java
index cf8c28d07..38dcd122f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java
@@ -62,7 +62,7 @@ public class Jasper41Mangler implements JspMangler {
/**
* Mangle the specified character to create a legal Java class name.
*/
- private static final String mangleChar(char ch) {
+ private static String mangleChar(char ch) {
String s = Integer.toHexString(ch);
int nzeros = 5 - s.length();
@@ -81,6 +81,7 @@ public class Jasper41Mangler implements JspMangler {
/**
* taking in the substring representing the path relative to the source dir
* return a new string representing the destination path
+ * @return null as this is not implemented.
* @todo
*/
public String mapPath(String path) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
index 8a0b9f0de..e570ad8e6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
@@ -629,6 +629,7 @@ public class JspC extends MatchingTask {
* @param srcFile the source file.
* @param srcDir the source directory.
* @param dest the destination directory.
+ * @return the filename.
* @todo support packages and subdirs
*/
protected File mapToJavaFile(JspMangler mangler, File srcFile, File srcDir, File dest) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java
index f6e2c6666..f62492c34 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java
@@ -39,6 +39,8 @@ public interface JspMangler {
/**
* taking in the substring representing the path relative to the source dir
* return a new string representing the destination path
+ * @param path the path to map.
+ * @return the mapped path.
*/
String mapPath(String path);
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
index e6067c033..e3cae4d52 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
@@ -70,6 +70,12 @@ import org.apache.tools.ant.types.Commandline;
*
*/
public class Pvcs extends org.apache.tools.ant.Task {
+ // CheckStyle - magic numbers
+ // checking for "X:\ 0=dquote,1=letter,2=:,3=\
+ private static final int POS_1 = 1;
+ private static final int POS_2 = 2;
+ private static final int POS_3 = 3;
+
private String pvcsbin;
private String repository;
private String pvcsProject;
@@ -101,6 +107,12 @@ public class Pvcs extends org.apache.tools.ant.Task {
private static final String GET_EXE = "get";
+ /**
+ * Run the command.
+ * @param cmd the command line to use.
+ * @param out the output stream handler to use.
+ * @return the exit code of the command.
+ */
protected int runCmd(Commandline cmd, ExecuteStreamHandler out) {
try {
Project aProj = getProject();
@@ -290,12 +302,13 @@ public class Pvcs extends org.apache.tools.ant.Task {
String line = in.readLine();
while (line != null) {
log("Considering \"" + line + "\"", Project.MSG_VERBOSE);
- if (line.startsWith("\"\\")
- || line.startsWith("\"/")
- || (line.length() > 3 && line.startsWith("\"")
- && Character.isLetter(line.charAt(1))
- && String.valueOf(line.charAt(2)).equals(":")
- && String.valueOf(line.charAt(3)).equals("\\"))) {
+ if (line.startsWith("\"\\") // Checking for "\
+ || line.startsWith("\"/") // or "/
+ // or "X:\...
+ || (line.length() > POS_3 && line.startsWith("\"")
+ && Character.isLetter(line.charAt(POS_1))
+ && String.valueOf(line.charAt(POS_2)).equals(":")
+ && String.valueOf(line.charAt(POS_3)).equals("\\"))) {
Object[] objs = mf.parse(line);
String f = (String) objs[1];
// Extract the name of the directory from the filename
@@ -337,9 +350,10 @@ public class Pvcs extends org.apache.tools.ant.Task {
/**
* Simple hack to handle the PVCS command-line tools botch when
* handling UNC notation.
+ * @throws IOException if there is an error.
*/
private void massagePCLI(File in, File out)
- throws FileNotFoundException, IOException {
+ throws IOException {
BufferedReader inReader = null;
BufferedWriter outWriter = null;
try {
@@ -374,6 +388,7 @@ public class Pvcs extends org.apache.tools.ant.Task {
* to parse the output of the pcli command. It defaults to
* {0}-arc({1}). Repositories where the archive
* extension is not -arc should set this.
+ * @return the filename format attribute.
*/
public String getFilenameFormat() {
return filenameFormat;
@@ -385,6 +400,7 @@ public class Pvcs extends org.apache.tools.ant.Task {
* java.text.MessageFormat.
* Index 1 of the format will be used as the file name.
* Defaults to {0}-arc({1})
+ * @param f the format to use.
*/
public void setFilenameFormat(String f) {
filenameFormat = f;
@@ -397,6 +413,7 @@ public class Pvcs extends org.apache.tools.ant.Task {
* knows about / and \\, this property is useful in cases where the
* repository is accessed on a Windows platform via a drive letter
* mapping.
+ * @return the lineStart attribute.
*/
public String getLineStart() {
return lineStart;
@@ -409,8 +426,8 @@ public class Pvcs extends org.apache.tools.ant.Task {
* drive letter P is incorrect for your setup, you may
* need to change this value, UNC names will always be
* accepted.
+ * @param l the value to use.
*/
-
public void setLineStart(String l) {
lineStart = l;
}
@@ -575,6 +592,7 @@ public class Pvcs extends org.apache.tools.ant.Task {
/**
* If set to true the return value from executing the pvcs
* commands are ignored; optional, default false.
+ * @param b a boolean value.
*/
public void setIgnoreReturnCode(boolean b) {
ignorerc = b;
@@ -582,12 +600,16 @@ public class Pvcs extends org.apache.tools.ant.Task {
/**
* Specify a project within the PVCS repository to extract files from.
- * @param p
+ * @param p the pvcs project to use.
*/
public void addPvcsproject(PvcsProject p) {
pvcsProjects.addElement(p);
}
+ /**
+ * get the updateOnly attribute.
+ * @return the updateOnly attribute.
+ */
public boolean getUpdateOnly() {
return updateOnly;
}
@@ -595,6 +617,7 @@ public class Pvcs extends org.apache.tools.ant.Task {
/**
* If set to true files are fetched only if
* newer than existing local files; optional, default false.
+ * @param l a boolean value.
*/
public void setUpdateOnly(boolean l) {
updateOnly = l;
@@ -618,14 +641,18 @@ public class Pvcs extends org.apache.tools.ant.Task {
}
+ /**
+ * Get the userid.
+ * @return the userid.
+ */
public String getUserId() {
return userId;
}
/**
* User ID
+ * @param u the value to use.
*/
-
public void setUserId(String u) {
userId = u;
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java
index fca9da440..a8c6a2a14 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java
@@ -26,12 +26,14 @@ package org.apache.tools.ant.taskdefs.optional.pvcs;
public class PvcsProject {
private String name;
+ /** no arg constructor */
public PvcsProject() {
super();
}
/**
* Set the name of the project
+ * @param name the value to use.
*/
public void setName(String name) {
PvcsProject.this.name = name;
@@ -39,6 +41,7 @@ public class PvcsProject {
/**
* Get the name of the project
+ * @return the name of the project.
*/
public String getName() {
return name;