cvs commit: jakarta-turbine-maven/src/java/org/apache/maven/j2ee WarFile.java

[dion]

dion        02/05/20 17:40:11

  Modified:    src/java/org/apache/maven/j2ee WarFile.java
  Log:
  Checkstyle issues
  
  Revision  Changes    Path
  1.6       +11 -2     
jakarta-turbine-maven/src/java/org/apache/maven/j2ee/WarFile.java
  
  Index: WarFile.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/j2ee/WarFile.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- WarFile.java      21 May 2002 00:01:01 -0000      1.5
  +++ WarFile.java      21 May 2002 00:40:11 -0000      1.6
  @@ -81,7 +81,7 @@
    * Represents a J2EE War File
    *
    * @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
  - * @version $Id: WarFile.java,v 1.5 2002/05/21 00:01:01 dion Exp $
  + * @version $Id: WarFile.java,v 1.6 2002/05/21 00:40:11 dion Exp $
    */
   public class WarFile extends JarFile
   {
  @@ -215,6 +215,8 @@
       
       /** Get a map of taglib-uri -> taglib-location. The map has zero size
        * if there are no taglibs defined or no web.xml in the war
  +     * @return a map of uri to location
  +     * @throws IOException when an I/O error occurs reading the war
        */
       public Map getTaglibs() throws IOException
       {
  @@ -284,7 +286,9 @@
       }
       
       /** Extract the given {@link JarEntry entry} to a temporary file
  +     * @param entry a previously retrieved entry from the jar file
        * @return the {@link File} created 
  +     * @throws IOException when an I/O error occurs reading the war
        */
       public File extract(JarEntry entry) throws IOException
       {
  @@ -309,10 +313,13 @@
       /** Tests whether a 'file' exists in the war. A file in this case is
        * a jar entry prefixed with a '/'. e.g. the file /WEB-INF/web.xml  is
        * the same as the jar entry WEB-INF/web.xml
  +     * @param fileName an entry in the war to be searched for
  +     * @return whether the entry exists
        */
       public boolean hasFile(String fileName)
       {
  -        if (fileName == null) {
  +        if (fileName == null)
  +        {
               throw new NullPointerException("fileName parameter can't be null");
           }
           
  @@ -331,6 +338,7 @@
       /** Get a map of error pages to error locations. The key of the map is
        * either the <code>&lt;error-code&gt;</code> or <code>&lt;
        * exception-type&gt;</code>, the value is <code>&lt;location&gt;</code>.
  +     * @return a map of error page to error location
        * @throws IOException if there are problems reading from the war
        */
       public Map getErrorPages() throws IOException
  @@ -365,6 +373,7 @@
       
       /** Get the <code>&lt;form-login-config&gt</code> details specified in the
        * war file, or null if the element is not present
  +     * @return a {@link FormLoginConfig} with the login and error pages
        * @throws IOException if there are problems reading from the war
        */
       public FormLoginConfig getFormLoginConfig() throws IOException 
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>