Author: peterreilly Date: Thu Nov 16 15:39:55 2006 New Revision: 475986 URL: http://svn.apache.org/viewvc?view=rev&rev=475986 Log: checkstyle
Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java Thu Nov 16 15:39:55 2006 @@ -214,6 +214,7 @@ /** * 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 @@ /** * 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 @@ /** * Flag (optional, default=false) to remove * the generated files in the BUILD directory + * @param cbd a <code>boolean</code> value. */ public void setCleanBuildDir(boolean cbd) { cleanBuildDir = cbd; @@ -239,6 +242,7 @@ /** * Flag (optional, default=false) to remove the spec file from SPECS + * @param rs a <code>boolean</code> value. */ public void setRemoveSpec(boolean rs) { removeSpec = rs; @@ -248,6 +252,7 @@ * Flag (optional, default=false) * to remove the sources after the build. * See the <tt>--rmsource</tt> option of rpmbuild. + * @param rs a <code>boolean</code> value. */ public void setRemoveSource(boolean rs) { removeSource = rs; @@ -255,6 +260,7 @@ /** * 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 @@ /** * 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 @@ } /** + * 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, Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java Thu Nov 16 15:39:55 2006 @@ -34,10 +34,14 @@ * 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 @@ /** * 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 @@ /** * call the program + * @throws BuildException if there is a problem. */ public void execute() throws BuildException { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java Thu Nov 16 15:39:55 2006 @@ -215,7 +215,9 @@ * Add an attribute nested element. This is used for setting arbitrary * features of the SAX parser. * Valid attributes - * <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description">include</a> + * <a href= + * "http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description" + * >include</a> * @return attribute created * @since ant1.6 */ @@ -653,7 +655,9 @@ public static class Attribute { /** The name of the attribute to set. * - * Valid attributes <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description">include.</a> + * Valid attributes <a href= + * "http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description" + * >include.</a> */ private String attributeName = null; Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java Thu Nov 16 15:39:55 2006 @@ -39,7 +39,11 @@ 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() { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java Thu Nov 16 15:39:55 2006 @@ -398,12 +398,17 @@ 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 Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java Thu Nov 16 15:39:55 2006 @@ -385,7 +385,13 @@ 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); } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java Thu Nov 16 15:39:55 2006 @@ -885,12 +885,10 @@ } } - /* 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); Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/JSharp.java Thu Nov 16 15:39:55 2006 @@ -34,8 +34,9 @@ * nested <code><src></code> elements instead of the basedir * attribute if you need more control.</p> * - * @see <A=ref="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dv_vjsharp/html/vjoriMicrosoftVisualJ.asp"> - * Visual J++ online documentation</a> + * @see <a ref= + * "http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dv_vjsharp/html/vjoriMicrosoftVisualJ.asp" + * >Visual J++ online documentation</a> * * @since ant1.6 * @ant.task category="dotnet" name="jsharpc" @@ -121,6 +122,7 @@ } } + /** [EMAIL PROTECTED] */ protected void createResourceParameter(NetCommand command, DotnetResource resource) { resource.getParameters(getProject(), command, true); } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java Thu Nov 16 15:39:55 2006 @@ -373,8 +373,8 @@ /** * 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? Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/VisualBasicCompile.java Thu Nov 16 15:39:55 2006 @@ -347,6 +347,7 @@ return "vb"; } + /** [EMAIL PROTECTED] */ protected void createResourceParameter(NetCommand command, DotnetResource resource) { resource.getParameters(getProject(), command, false); } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java Thu Nov 16 15:39:55 2006 @@ -619,7 +619,7 @@ * @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() ]; Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.java Thu Nov 16 15:39:55 2006 @@ -217,6 +217,8 @@ } /** + * a debug toString method. + * @return the extension in a string. * @see java.lang.Object#toString() */ public String toString() { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.java Thu Nov 16 15:39:55 2006 @@ -117,6 +117,7 @@ /** * @see java.lang.Object#toString() + * @return the extensions in a string. */ public String toString() { return "ExtensionSet" + Arrays.asList(toExtensions(getProject())); Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java Thu Nov 16 15:39:55 2006 @@ -123,12 +123,17 @@ } /** - * + * 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; } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java Thu Nov 16 15:39:55 2006 @@ -27,35 +27,35 @@ */ 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); } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java Thu Nov 16 15:39:55 2006 @@ -114,6 +114,7 @@ * 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 @@ 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(); } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.java Thu Nov 16 15:39:55 2006 @@ -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 @@ 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 +} Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.java Thu Nov 16 15:39:55 2006 @@ -52,6 +52,7 @@ * @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) Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.java Thu Nov 16 15:39:55 2006 @@ -31,11 +31,14 @@ */ 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 @@ return cmd; } -} \ No newline at end of file +} Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.java Thu Nov 16 15:39:55 2006 @@ -34,11 +34,14 @@ */ 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 { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.java Thu Nov 16 15:39:55 2006 @@ -29,7 +29,7 @@ * 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 @@ 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(); Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java Thu Nov 16 15:39:55 2006 @@ -37,6 +37,7 @@ import java.util.zip.ZipFile; import java.util.zip.ZipOutputStream; +// CheckStyle:TypeNameCheck OFF - bc /** * jlink links together multiple .jar files. */ @@ -51,7 +52,11 @@ 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. Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.java Thu Nov 16 15:39:55 2006 @@ -62,7 +62,7 @@ /** * 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 @@ /** * 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) { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java Thu Nov 16 15:39:55 2006 @@ -629,6 +629,7 @@ * @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) { Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.java Thu Nov 16 15:39:55 2006 @@ -39,6 +39,8 @@ /** * 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); Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java Thu Nov 16 15:39:55 2006 @@ -70,6 +70,12 @@ * */ 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 @@ 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 @@ 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 @@ /** * 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 @@ * to parse the output of the pcli command. It defaults to * <code>{0}-arc({1})</code>. 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 @@ * <code>java.text.MessageFormat</code>. * Index 1 of the format will be used as the file name. * Defaults to <code>{0}-arc({1})</code> + * @param f the format to use. */ public void setFilenameFormat(String f) { filenameFormat = f; @@ -397,6 +413,7 @@ * 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 @@ * drive letter <code>P</code> 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 @@ /** * If set to true the return value from executing the pvcs * commands are ignored; optional, default false. + * @param b a <code>boolean</code> value. */ public void setIgnoreReturnCode(boolean b) { ignorerc = b; @@ -582,12 +600,16 @@ /** * 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 @@ /** * If set to <i>true</i> files are fetched only if * newer than existing local files; optional, default false. + * @param l a <code>boolean</code> value. */ public void setUpdateOnly(boolean l) { updateOnly = l; @@ -618,14 +641,18 @@ } + /** + * 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; } Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java?view=diff&rev=475986&r1=475985&r2=475986 ============================================================================== --- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java (original) +++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.java Thu Nov 16 15:39:55 2006 @@ -26,12 +26,14 @@ 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 @@ /** * Get the name of the project + * @return the name of the project. */ public String getName() { return name; --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]