From f2d612279c15648fd06361849bec7e0c33046d74 Mon Sep 17 00:00:00 2001 From: Magesh Umasankar Date: Wed, 17 Apr 2002 14:59:12 +0000 Subject: [PATCH] Only significant change is: - src="file://D:\javaext\jakarta-ant-1.4alpha\docs\manual\Integration\anttool1.gif" + src="anttool1.gif" git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272489 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/Integration/VAJAntTool.html | 266 ++++++++++++------------ 1 file changed, 133 insertions(+), 133 deletions(-) diff --git a/docs/manual/Integration/VAJAntTool.html b/docs/manual/Integration/VAJAntTool.html index adfefaa07..edbab0f21 100644 --- a/docs/manual/Integration/VAJAntTool.html +++ b/docs/manual/Integration/VAJAntTool.html @@ -10,10 +10,10 @@

Visual Age for Java Tasks and Plugin User Manual

by Version 1.2 - 2001/06/14

@@ -22,30 +22,30 @@ Version 1.2 - 2001/06/14
  • Introduction
  • The Tasks
  • A sample build file
  • The Plugin -
  • Frequently Asked Questions> -
  • Visual Age Versions> +
  • Frequently Asked Questions> +
  • Visual Age Versions>
  • History

  • Introduction

    -

    Visual Age for Java is a great Java IDE, but it lacks -decent build support; for creating deliveries. On the other hand, Ant supports -the build process very good, but is (at least at the moment) command line based. -So we decided to write some tasks to access the VAJ repository and a small -visual Ant frontend to make running Ant from VAJ possible. We use the Tool API -to integrate Ant in VisualAge for Java. In combination with the VAJ tasks -(vajload, vajexport, vajimport) you can load defined versions of projects -into your workspace, export the source code, compile it with an external -compiler and build a jar without leaving the IDE. Of course compile messages are -viewed in a logging window. Concluding: This tool provides decent deployment +

    Visual Age for Java is a great Java IDE, but it lacks +decent build support; for creating deliveries. On the other hand, Ant supports +the build process very good, but is (at least at the moment) command line based. +So we decided to write some tasks to access the VAJ repository and a small +visual Ant frontend to make running Ant from VAJ possible. We use the Tool API +to integrate Ant in VisualAge for Java. In combination with the VAJ tasks +(vajload, vajexport, vajimport) you can load defined versions of projects +into your workspace, export the source code, compile it with an external +compiler and build a jar without leaving the IDE. Of course compile messages are +viewed in a logging window. Concluding: This tool provides decent deployment support VAJ has not (out of the box).

    What's new

    @@ -58,12 +58,12 @@ support VAJ has not (out of the box).

    from the command line (Kudos to Glenn McAllister for describing the concept and providing source code at - http://www7.software.ibm.com/vad.nsf/Data/Document4366.  + http://www7.software.ibm.com/vad.nsf/Data/Document4366.  -
  • It is possible to cancel a running build - executed from the plugin -
  • Improved error handling in the plugin. Now all - errors should show up either in the log window or in the +
  • It is possible to cancel a running build + executed from the plugin +
  • Improved error handling in the plugin. Now all + errors should show up either in the log window or in the console.
  • The Tasks

    @@ -89,7 +89,7 @@ contents into an external build process:

    VAJLoad

    Description:

    -

    Loads a specified VAJ project version into the +

    Loads a specified VAJ project version into the workspace.

    Parameters

    @@ -103,8 +103,8 @@ workspace.

    remote

    name and port of a remote tool server. (format: - <servername>:<port no>).
    If this - attribute is set, the tasks will be executed on the specified tool + <servername>:<port no>).
    If this + attribute is set, the tasks will be executed on the specified tool server. 

    no @@ -118,7 +118,7 @@ workspace.

    Required name - name of the VAJ project to load into + name of the VAJ project to load into the workspace yes @@ -129,8 +129,8 @@ workspace.

    remote

    name and port of a remote tool server. (format: - <servername>:<port no>).
    If this - attribute is set, the tasks will be executed on the specified tool + <servername>:<port no>).
    If this + attribute is set, the tasks will be executed on the specified tool server. 

    no @@ -159,17 +159,17 @@ FileSets.

    Required destdir - location to store the exported + location to store the exported files yes exportSources - export source files (default: + export source files (default: "yes") no exportResources - export resource files (default: + export resource files (default: "yes") no @@ -178,27 +178,27 @@ files no exportDebugInfo - include debug info in exported class + include debug info in exported class files (default: "no") no defaultexcludes -

    use default excludes when exporting (default: "yes").
    Default excludes are: IBM*/**, Java - class libraries/**, Sun class libraries*/**, JSP Page Compile Generated +

    use default excludes when exporting (default: "yes").
    Default excludes are: IBM*/**, Java + class libraries/**, Sun class libraries*/**, JSP Page Compile Generated Code/**, VisualAge*/** 

    no overwrite - overwrite existing files (default: + overwrite existing files (default: "yes") no remote

    name and port of a remote tool server. (format: - <servername>:<port no>).
    If this - attribute is set, the tasks will be executed on the specified tool + <servername>:<port no>).
    If this + attribute is set, the tasks will be executed on the specified tool server. 

    no @@ -217,7 +217,7 @@ specifies the packages to include into the export name name of the VAJ project and package to export.
    The first element of the name must be the project name,
    - then the package name elements + then the package name elements separated by '/'. yes @@ -232,7 +232,7 @@ specifies the packages to exclude from the export
    Required name - name of the VAJ project/package not to + name of the VAJ project/package not to export yes @@ -256,8 +256,8 @@ The default excludes are:

    VAJImport

    Description:

    -

    Imports Java source files, class files and/or resources -from the file system into VAJ. These imports can be specified with a fileset. +

    Imports Java source files, class files and/or resources +from the file system into VAJ. These imports can be specified with a fileset.

    Parameters

    @@ -268,17 +268,17 @@ from the file system into VAJ. These imports can be specified with a fileset. - - - @@ -289,8 +289,8 @@ from the file system into VAJ. These imports can be specified with a fileset.
    Required
    vajProjectimported files are added to this VAJ + imported files are added to this VAJ project yes
    importSourcesexport source files (default: + export source files (default: "yes") no
    importResourcesexport resource files (default: + export resource files (default: "yes") no
    remote

    name and port of a remote tool server. (format: - <servername>:<port no>).
    If this - attribute is set, the tasks will be executed on the specified tool + <servername>:<port no>).
    If this + attribute is set, the tasks will be executed on the specified tool server. 

    no
    @@ -311,7 +311,7 @@ This example imports all class files in the directory ${import.dir}/com/sample excluding those in the subdirectory test

    -

    The +

    The Plugin

    The tasks are usable within VAJ by running the org.apache.tools.ant.Main class, but this is @@ -330,48 +330,48 @@ of the authors.

    install directory. If You have installed it elsewhere, adapt the pathes below.

    Plugin

    Servlets for Remote Tool Access

    -

    Now you should be able to execute VAJ Tasks from the +

    Now you should be able to execute VAJ Tasks from the command line.


    @@ -416,39 +416,39 @@ command line.

    file is configured, it is really easy to use.
    Go to your Workbench, select the project you want to deploy and open its context menu. In the submenu Tools you should find -the new entry Ant Build. Klick it to start the tool!

    +the new entry Ant Build. Klick it to start the tool!

    After a short time this frame should pop up:
    This frame contains the following elements:

    After you have set up your buildprocess you might find it useful to save the data you've just entered, so we implemented an option to save it to the repository into your selected project. Make sure that you have an open edition of your project before selecting -Save +Save BuildInfo To Repository from the File menu. Now your information is saved to this edition of your project and will be loaded automatically the next time you start Ant Build.
    @@ -456,41 +456,41 @@ If you have closed the log window accidentally, it can be reopened with the Log item in the File menu, and if you want to know who developed this, just select About in the Help menu.

    Servlets for Remote Tool Access

    -

    With the servlets installed and the remote access -running you can use Ant from the command line without any restrictions. Just -make sure the remote attribute in your build file is set correctly.

    +

    With the servlets installed and the remote access +running you can use Ant from the command line without any restrictions. Just +make sure the remote attribute in your build file is set correctly.


    -

    Frequently Asked +

    Frequently Asked Questions

    -

    Q: If I try to load a build +

    Q: If I try to load a build file, I get the error "Can't load default task list". Why?
    -A: Ant not only contains class files, but also resource -files. This messsage appears if the file -
    .../org/apache/tools/ant/taskdefs/defaults.properties is -missing. Make sure that you import/export not only java/class files, but also +A: Ant not only contains class files, but also resource +files. This messsage appears if the file +
    .../org/apache/tools/ant/taskdefs/defaults.properties is +missing. Make sure that you import/export not only java/class files, but also all resource files when importing/exporting Ant.

    -

    Q: I want to load, export +

    Q: I want to load, export and build more then one Visual Age project to one jar! How to?
    -A: The VA tasks are able to load and export several -Projects all at once. You can choose whatever project you like for storing the +A: The VA tasks are able to load and export several +Projects all at once. You can choose whatever project you like for storing the tool information, it doesn't really matter

    -

    Q: When I load my build +

    Q: When I load my build file, the list of targets is empty. Why?
    -A: You -need to add the optional "description" parameter to the targets you want to come -up in the list. Then reload the build file in the "ant build" tool. We chose to -display only targets with description to allow the build file developer to +A: You +need to add the optional "description" parameter to the targets you want to come +up in the list. Then reload the build file in the "ant build" tool. We chose to +display only targets with description to allow the build file developer to distinguish between targets for end users and helper targets.

    -

    Q: Is there a sample build +

    Q: Is there a sample build file available?
    A: Now you can find an example in this manual

    -

    Q: Why does it export my -entire workspace when I've already implicitly selected a project when starting +

    Q: Why does it export my +entire workspace when I've already implicitly selected a project when starting the Tool?
    -A: This selection does not carry into -the buildfile you are using. Set the Project name at the beginning of the +A: This selection does not carry into +the buildfile you are using. Set the Project name at the beginning of the "includes" parameter.

    -

    Q: When I import Ant into +

    Q: When I import Ant into my Workspace, I get Problems reported. Can I ignore them?
    A: It depends on the problems reported, and what you want to do with Ant. Problems you can't ignore: @@ -499,45 +499,45 @@ Problems you can't ignore: (see installation)

  • Classes from com.ibm.ivj.util missing - install the Visual Age IDE Utility feature (see installation). -
  • Errors in optional tasks you use within your build +
  • Errors in optional tasks you use within your build file

  • -

    Q: I want to use the same -buildfile both within Visual Age and from the command line using my regular Ant +

    Q: I want to use the same +buildfile both within Visual Age and from the command line using my regular Ant environment. What do I need to be aware of?
    -A: -You have to specifie a remote server via the 'remote' attribute. Otherwise the +A: +You have to specifie a remote server via the 'remote' attribute. Otherwise the three Visual Age tasks won't work when executing Ant from the command line.

    -

    Q: I can export packages +

    Q: I can export packages from project 'ABC', but not from project 'XYZ'! Why?
    A: Common reasons are:

      -
    • The project is excluded by the default excludes (see - attribute 'defaultexcludes' of VAJExport) -
    • When looking at the project in the workspace, it is - often difficult to distinguish between project name and version name (e.g. as - in 'My GUI Components Java 2 3.5'). Check if you have the right project name +
    • The project is excluded by the default excludes (see + attribute 'defaultexcludes' of VAJExport) +
    • When looking at the project in the workspace, it is + often difficult to distinguish between project name and version name (e.g. as + in 'My GUI Components Java 2 3.5'). Check if you have the right project name by switching off the version name display temporarilly.
    -

    Q: How do I control the -import/export of sourcefiles, compiled files and project resources +

    Q: How do I control the +import/export of sourcefiles, compiled files and project resources explicity?
    -A: Via the Boolean values -exportClasses (default false) exportSources (default true) and exportResources -(default true). In some situations, Resources are not exported correctly without -this being explicity set. VAJ doesn't export resources correctly if a package +A: Via the Boolean values +exportClasses (default false) exportSources (default true) and exportResources +(default true). In some situations, Resources are not exported correctly without +this being explicity set. VAJ doesn't export resources correctly if a package contains only resources (see below).


    -

    Known +

    Known Problems

      -
    • Exporting a package containing just resources doesn't - work. This is a VAJ Tool API bug. Workaround: create a dummy class and set +
    • Exporting a package containing just resources doesn't + work. This is a VAJ Tool API bug. Workaround: create a dummy class and set 'exportSources' to false.

    -

    VisualAge +

    VisualAge for Java Versions

    This tool integration has been tested with versions 3.02 and 3.5 of VisualAge for Java. It should run with the 2.x Versions, too, but @@ -554,7 +554,7 @@ JDK independent by now. 1.1 2001/02/14 - Added Task documentation and more FAQs + Added Task documentation and more FAQs (thanks to Richard Bourke for the FAQ additions) 1.2 @@ -562,7 +562,7 @@ JDK independent by now.

    Added documentation of new remote feature.
    Minor corrections.


    -
    Copyright &#copy 2001 Apache Software +
    Copyright &#copy 2001,2002 Apache Software Foundation. All rights Reserved.