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/05/25 16:28:16 UTC

cvs commit: ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers JspCompilerAdapterFactory.java JspCompilerAdapter.java JasperC.java DefaultJspCompilerAdapter.java

peterreilly    2005/05/25 07:28:16

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers
                        JspCompilerAdapterFactory.java
                        JspCompilerAdapter.java JasperC.java
                        DefaultJspCompilerAdapter.java
  Log:
  checkstyle - mostly javadoc
  
  Revision  Changes    Path
  1.12      +4 -2      ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java
  
  Index: JspCompilerAdapterFactory.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- JspCompilerAdapterFactory.java	9 Mar 2004 16:48:30 -0000	1.11
  +++ JspCompilerAdapterFactory.java	25 May 2005 14:28:16 -0000	1.12
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2001-2004 The Apache Software Foundation
  + * Copyright  2001-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.
  @@ -27,7 +27,7 @@
    * Creates the necessary compiler adapter, given basic criteria.
    *
    */
  -public class JspCompilerAdapterFactory {
  +public final class JspCompilerAdapterFactory {
   
       /** This is a singleton -- can't create instances!! */
       private JspCompilerAdapterFactory() {
  @@ -46,6 +46,7 @@
        * @param compilerType either the name of the desired compiler, or the
        * full classname of the compiler's adapter.
        * @param task a task to log through.
  +     * @return the compiler
        * @throws BuildException if the compiler type could not be resolved into
        * a compiler adapter.
        */
  @@ -69,6 +70,7 @@
        * full classname of the compiler's adapter.
        * @param task a task to log through.
        * @param loader AntClassLoader with which the compiler should be loaded
  +     * @return the compiler
        * @throws BuildException if the compiler type could not be resolved into
        * a compiler adapter.
        */
  
  
  
  1.10      +3 -1      ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java
  
  Index: JspCompilerAdapter.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- JspCompilerAdapter.java	9 Mar 2004 16:48:30 -0000	1.9
  +++ JspCompilerAdapter.java	25 May 2005 14:28:16 -0000	1.10
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2001-2004 The Apache Software Foundation
  + * Copyright  2001-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.
  @@ -36,6 +36,7 @@
   
       /**
        * Sets the compiler attributes, which are stored in the Jspc task.
  +     * @param attributes the jsp compiler attributes
        */
       void setJspc(JspC attributes);
   
  @@ -43,6 +44,7 @@
        * Executes the task.
        *
        * @return has the compilation been successful
  +     * @throws BuildException on error
        */
       boolean execute() throws BuildException;
   
  
  
  
  1.26      +8 -2      ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java
  
  Index: JasperC.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- JasperC.java	18 Feb 2005 23:28:00 -0000	1.25
  +++ JasperC.java	25 May 2005 14:28:16 -0000	1.26
  @@ -41,12 +41,18 @@
        */
       JspMangler mangler;
   
  +    /**
  +     * Constructor for JasperC.
  +     * @param mangler a filename converter
  +     */
       public JasperC(JspMangler mangler) {
           this.mangler = mangler;
       }
   
       /**
  -     * our execute method
  +     * Our execute method.
  +     * @return true if successful
  +     * @throws BuildException on error
        */
       public boolean execute()
           throws BuildException {
  @@ -69,7 +75,7 @@
               java.setDir(getProject().getBaseDir());
               java.setClassname("org.apache.jasper.JspC");
               //this is really irritating; we need a way to set stuff
  -            String args[] = cmd.getJavaCommand().getArguments();
  +            String []args = cmd.getJavaCommand().getArguments();
               for (int i = 0; i < args.length; i++) {
                   java.createArg().setValue(args[i]);
               }
  
  
  
  1.16      +8 -4      ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java
  
  Index: DefaultJspCompilerAdapter.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- DefaultJspCompilerAdapter.java	9 Mar 2004 16:48:30 -0000	1.15
  +++ DefaultJspCompilerAdapter.java	25 May 2005 14:28:16 -0000	1.16
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2001-2004 The Apache Software Foundation
  + * Copyright  2001-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.
  @@ -38,6 +38,9 @@
       /**
        * Logs the compilation parameters, adds the files to compile and logs the
        * &quot;niceSourceList&quot;
  +     * @param jspc the compiler task for logging
  +     * @param compileList the list of files to compile
  +     * @param cmd the command line used
        */
       protected void logAndAddFilesToCompile(JspC jspc,
                                              Vector compileList,
  @@ -70,6 +73,7 @@
   
       /**
        * set the owner
  +     * @param owner the owner JspC compiler
        */
       public void setJspc(JspC owner) {
           this.owner = owner;
  @@ -85,7 +89,7 @@
   
       /**
        *  add an argument oneple to the argument list, if the value aint null
  -     *
  +     * @param cmd the command line
        * @param  argument  The argument
        */
       protected void addArg(CommandlineJava cmd, String argument) {
  @@ -97,7 +101,7 @@
   
       /**
        *  add an argument tuple to the argument list, if the value aint null
  -     *
  +     * @param cmd the command line
        * @param  argument  The argument
        * @param  value     the parameter
        */
  @@ -110,7 +114,7 @@
   
       /**
        *  add an argument tuple to the arg list, if the file parameter aint null
  -     *
  +     * @param cmd the command line
        * @param  argument  The argument
        * @param  file     the parameter
        */
  
  
  

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