org.apache.tools.ant.taskdefs.optional.ide

Class VAJExport


public class VAJExport
extends VAJTask

Export packages from the Visual Age for Java workspace. The packages are specified similar to all other MatchingTasks. Since the VA Workspace is not file based, this task is simulating a directory hierarchy for the workspace: The 'root' contains all project 'dir's, and the projects contain their respective package 'dir's. Example:
<vajexport destdir="C:/builddir/source">  <include name="/MyVAProject/org/foo/subsystem1/**" />  <exclude name="/MyVAProject/org/foo/subsystem1/test/**"/> </vajexport>
exports all packages in the project MyVAProject which start with 'org.foo.subsystem1' except of these starting with 'org.foo.subsystem1.test'.

Parameters:

AttributeDescriptionRequired
destdirlocation to store the exported filesYes
exportSourcesexport Java sources, defaults to "yes"No
exportResourcesexport resource files, defaults to "yes"No
exportClassesexport class files, defaults to "no"No
exportDebugInfoinclude debug info in exported class files, defaults to "no"No
defaultexcludesuse default excludes when exporting, defaults to "yes". Default excludes are: IBM/**, Java class libraries/**, Sun class libraries/**, JSP Page Compile Generated Code/**, Visual Age*/**No
overwriteoverwrite existing files, defaults to "yes"No
remoteremote tool server to run this command against (format: <servername> : <port no>)No
haltonerrorstop the build process if an error occurs, defaults to "yes"No

Field Summary

protected File
destDir
protected boolean
exportClasses
protected boolean
exportDebugInfo
protected boolean
exportResources
protected boolean
exportSources
protected boolean
overwrite
protected PatternSet
patternSet
protected boolean
useDefaultExcludes

Fields inherited from class org.apache.tools.ant.taskdefs.optional.ide.VAJTask

haltOnError, remoteServer

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

Method Summary

PatternSet.NameEntry
createExclude()
add a name entry on the exclude list
PatternSet.NameEntry
createInclude()
add a name entry on the include list
void
execute()
do the export
void
setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not; default true.
void
setDestdir(File destDir)
Set the destination directory into which the selected items should be exported; required.
void
setExcludes(String excludes)
Sets the set of exclude patterns.
void
setExportClasses(boolean doExport)
optional flag to export the class files; default false.
void
setExportDebugInfo(boolean doExport)
optional flag to export the debug info; default false.
void
setExportResources(boolean doExport)
optional flag to export the resource file; default true.
void
setExportSources(boolean doExport)
optional flag to export the Java files; default true.
void
setIncludes(String includes)
Sets the set of include patterns.
void
setOverwrite(boolean doOverwrite)
if Overwrite is set, files will be overwritten during export

Methods inherited from class org.apache.tools.ant.taskdefs.optional.ide.VAJTask

getUtil, setHaltonerror, setRemote

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

execute, 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, log, log, setProject

Field Details

destDir

protected File destDir

exportClasses

protected boolean exportClasses

exportDebugInfo

protected boolean exportDebugInfo

exportResources

protected boolean exportResources

exportSources

protected boolean exportSources

overwrite

protected boolean overwrite

patternSet

protected PatternSet patternSet

useDefaultExcludes

protected boolean useDefaultExcludes

Method Details

createExclude

public PatternSet.NameEntry createExclude()
add a name entry on the exclude list

createInclude

public PatternSet.NameEntry createInclude()
add a name entry on the include list

execute

public void execute()
            throws BuildException
do the export
Overrides:
execute in interface Task

setDefaultexcludes

public void setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not; default true.
Parameters:
useDefaultExcludes - "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

setDestdir

public void setDestdir(File destDir)
Set the destination directory into which the selected items should be exported; required.

setExcludes

public void setExcludes(String excludes)
Sets the set of exclude patterns. Patterns may be separated by a comma or a space. Currently only patterns denoting packages are supported
Parameters:
excludes - the string containing the exclude patterns

setExportClasses

public void setExportClasses(boolean doExport)
optional flag to export the class files; default false.

setExportDebugInfo

public void setExportDebugInfo(boolean doExport)
optional flag to export the debug info; default false. debug info

setExportResources

public void setExportResources(boolean doExport)
optional flag to export the resource file; default true.

setExportSources

public void setExportSources(boolean doExport)
optional flag to export the Java files; default true.

setIncludes

public void setIncludes(String includes)
Sets the set of include patterns. Patterns may be separated by a comma or a space. Currently only patterns denoting packages are supported
Parameters:
includes - the string containing the include patterns

setOverwrite

public void setOverwrite(boolean doOverwrite)
if Overwrite is set, files will be overwritten during export

Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.