Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 166   Methods: 4
NCLOC: 67   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
JarLibDisplayTask.java 0% 0% 0% 0%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2002 The Apache Software Foundation.  All rights
 5   
  * reserved.
 6   
  *
 7   
  * Redistribution and use in source and binary forms, with or without
 8   
  * modification, are permitted provided that the following conditions
 9   
  * are met:
 10   
  *
 11   
  * 1. Redistributions of source code must retain the above copyright
 12   
  *    notice, this list of conditions and the following disclaimer.
 13   
  *
 14   
  * 2. Redistributions in binary form must reproduce the above copyright
 15   
  *    notice, this list of conditions and the following disclaimer in
 16   
  *    the documentation and/or other materials provided with the
 17   
  *    distribution.
 18   
  *
 19   
  * 3. The end-user documentation included with the redistribution, if
 20   
  *    any, must include the following acknowlegement:
 21   
  *       "This product includes software developed by the
 22   
  *        Apache Software Foundation (http://www.apache.org/)."
 23   
  *    Alternately, this acknowlegement may appear in the software itself,
 24   
  *    if and wherever such third-party acknowlegements normally appear.
 25   
  *
 26   
  * 4. The names "Ant" and "Apache Software
 27   
  *    Foundation" must not be used to endorse or promote products derived
 28   
  *    from this software without prior written permission. For written
 29   
  *    permission, please contact apache@apache.org.
 30   
  *
 31   
  * 5. Products derived from this software may not be called "Apache"
 32   
  *    nor may "Apache" appear in their names without prior written
 33   
  *    permission of the Apache Group.
 34   
  *
 35   
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 36   
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 37   
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 38   
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 39   
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 40   
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 41   
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 42   
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 43   
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 44   
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 45   
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 46   
  * SUCH DAMAGE.
 47   
  * ====================================================================
 48   
  *
 49   
  * This software consists of voluntary contributions made by many
 50   
  * individuals on behalf of the Apache Software Foundation.  For more
 51   
  * information on the Apache Software Foundation, please see
 52   
  * <http://www.apache.org/>.
 53   
  */
 54   
 package org.apache.tools.ant.taskdefs.optional.extension;
 55   
 
 56   
 import java.io.File;
 57   
 import java.util.Iterator;
 58   
 import java.util.Vector;
 59   
 import org.apache.tools.ant.BuildException;
 60   
 import org.apache.tools.ant.DirectoryScanner;
 61   
 import org.apache.tools.ant.Task;
 62   
 import org.apache.tools.ant.types.FileSet;
 63   
 
 64   
 /**
 65   
  * Displays the "Optional Package" and "Package Specification" information
 66   
  * contained within the specified JARs.
 67   
  *
 68   
  * <p>Prior to JDK1.3, an "Optional Package" was known as an Extension.
 69   
  * The specification for this mechanism is available in the JDK1.3
 70   
  * documentation in the directory
 71   
  * $JDK_HOME/docs/guide/extensions/versioning.html. Alternatively it is
 72   
  * available online at <a href="http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html">
 73   
  * http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html</a>.</p>
 74   
  *
 75   
  * @author <a href="mailto:peter@apache.org">Peter Donald</a>
 76   
  * @ant.task name="jarlib-display"
 77   
  */
 78   
 public class JarLibDisplayTask
 79   
     extends Task
 80   
 {
 81   
     /**
 82   
      * The library to display information about.
 83   
      */
 84   
     private File m_file;
 85   
 
 86   
     /**
 87   
      * Filesets specifying all the librarys
 88   
      * to display information about.
 89   
      */
 90   
     private final Vector m_filesets = new Vector();
 91   
 
 92   
     /**
 93   
      * The JAR library to display information for.
 94   
      *
 95   
      * @param file The jar library to display information for.
 96   
      */
 97  0
     public void setFile( final File file )
 98   
     {
 99  0
         m_file = file;
 100   
     }
 101   
 
 102   
     /**
 103   
      * Adds a set of files about which library data will be displayed.
 104   
      *
 105   
      * @param fileSet a set of files about which library data will be displayed.
 106   
      */
 107  0
     public void addFileset( final FileSet fileSet )
 108   
     {
 109  0
         m_filesets.addElement( fileSet );
 110   
     }
 111   
 
 112  0
     public void execute()
 113   
         throws BuildException
 114   
     {
 115  0
         validate();
 116   
 
 117  0
         final LibraryDisplayer displayer = new LibraryDisplayer();
 118   
         // Check if list of files to check has been specified
 119  0
         if( !m_filesets.isEmpty() )
 120   
         {
 121  0
             final Iterator iterator = m_filesets.iterator();
 122  0
             while( iterator.hasNext() )
 123   
             {
 124  0
                 final FileSet fileSet = (FileSet)iterator.next();
 125  0
                 final DirectoryScanner scanner = fileSet.getDirectoryScanner( getProject() );
 126  0
                 final File basedir = scanner.getBasedir();
 127  0
                 final String[] files = scanner.getIncludedFiles();
 128  0
                 for( int i = 0; i < files.length; i++ )
 129   
                 {
 130  0
                     final File file = new File( basedir, files[ i ] );
 131  0
                     displayer.displayLibrary( file );
 132   
                 }
 133   
             }
 134   
         }
 135   
         else
 136   
         {
 137  0
             displayer.displayLibrary( m_file );
 138   
         }
 139   
     }
 140   
 
 141   
     /**
 142   
      * Validate the tasks parameters.
 143   
      *
 144   
      * @throws BuildException if invalid parameters found
 145   
      */
 146  0
     private void validate()
 147   
         throws BuildException
 148   
     {
 149  0
         if( null == m_file && m_filesets.isEmpty() )
 150   
         {
 151  0
             final String message = "File attribute not specified.";
 152  0
             throw new BuildException( message );
 153   
         }
 154  0
         if( null != m_file && !m_file.exists() )
 155   
         {
 156  0
             final String message = "File '" + m_file + "' does not exist.";
 157  0
             throw new BuildException( message );
 158   
         }
 159  0
         if( null != m_file && !m_file.isFile() )
 160   
         {
 161  0
             final String message = "\'" + m_file + "\' is not a file.";
 162  0
             throw new BuildException( message );
 163   
         }
 164   
     }
 165   
 }
 166