com.sun.tdk.signaturetest.ant
Class ASetup

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.sun.tdk.signaturetest.ant.ASuperBase
              com.sun.tdk.signaturetest.ant.ABase
                  com.sun.tdk.signaturetest.ant.ASetup

public class ASetup
extends ABase

 Ant wrapper for setup command

 Required parameters:
   "package" attribute or nested "package" element is required.
     Corresponds to -package option
     Samples -
     <setup package="javax.swing" ...
     or
     <setup ...
       <package name="javax.swing" />
       <package name="java.lang" />
       ...
     </setup>
   "classpath" attribute or nested "classpath" element is required.
     Corresponds to -classpath option

   "filename" attribute is required.
     Corresponds to -filename option

 Optional parameters:
   "failonerror" - Stop the build process if the command exits with an error. Default is "false".
   "apiVersion" -  corresponds to -apiVersion. Set API version for signature file
   "nonclosedfile" - Corresponds to -NonClosedFile option, Default is "false".
   "negative" - inverts result (that is passed status treats as failed and vice versa, default is "false"
   "exclude" attribute or nested "exclude" element. Corresponds to -exclude option.
     package or class, which is not required to be tested
     Samples -
     <setup package="javax.swing" exclude="javax.swing.text.ParagraphView" ...
     or
     <setup ...
       <exclude package="javax.swing.text" />
       <exclude class="javax.swing.JTree$EmptySelectionModel" />
       ...
     </setup>

 Task definition sample:
 <taskdef name="setup"
   classname="com.sun.tdk.signaturetest.ant.ASetup"
   classpath="sigtestdev.jar"/>

 Task usage sample:
 <setup package="javax.swing" failonerror="true" apiVersion="swing"
   filename="javax_swing.sig">
   <classpath>
      <pathelement location="/opt/java/jdk1.6.0_04/jre/lib/rt.jar"/>
   </classpath>

   <exclude class="javax.swing.tree.DefaultTreeSelectionModel"/>
   <exclude class="javax.swing.text.ParagraphView"/>
   <exclude class="javax.swing.tree.DefaultTreeSelectionModel"/>
   <exclude class="javax.swing.plaf.basic.BasicTextFieldUI$I18nFieldView"/>
   <exclude class="javax.swing.JEditorPane$PlainEditorKit$PlainParagraph"/>
   <exclude class="javax.swing.text.html.ParagraphView"/>
   <exclude class="javax.swing.plaf.basic.BasicTextAreaUI$PlainParagraph"/>
   <exclude class="javax.swing.JTree$EmptySelectionModel"/>
 </setup>
 

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.tdk.signaturetest.ant.ABase

ABase.AExclude, ABase.APackage

Field Summary

Fields inherited from class com.sun.tdk.signaturetest.ant.ASuperBase

failOnError, negative

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

ASetup()

Method Summary

void	execute()
void	setNonclosedFile(boolean b)

Methods inherited from class com.sun.tdk.signaturetest.ant.ABase

createClasspath, createExclude, createPackage, setApiVersion, setClasspath, setExclude, setFilename, setPackage

Methods inherited from class com.sun.tdk.signaturetest.ant.ASuperBase

setFailonerror, setNegative

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ASetup

public ASetup()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

setNonclosedFile

public void setNonclosedFile(boolean b)