Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » optional » ide » [javadoc | source]

org.apache.tools.ant.taskdefs.optional.ide
public class: VAJExport [javadoc | source]

java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.optional.ide.VAJTask
            org.apache.tools.ant.taskdefs.optional.ide.VAJExport

All Implemented Interfaces:
    Cloneable

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:

Attribute	Description	Required
destdir	location to store the exported files	Yes
exportSources	export Java sources, defaults to "yes"	No
exportResources	export resource files, defaults to "yes"	No
exportClasses	export class files, defaults to "no"	No
exportDebugInfo	include debug info in exported class files, defaults to "no"	No
defaultexcludes	use 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
overwrite	overwrite existing files, defaults to "yes"	No
remote	remote tool server to run this command against (format: <servername> : <port no>)	No
haltonerror	stop the build process if an error occurs, defaults to "yes"	No

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

Fields inherited from org.apache.tools.ant.taskdefs.optional.ide.VAJTask:
remoteServer,  haltOnError

Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper

Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description

Method from org.apache.tools.ant.taskdefs.optional.ide.VAJExport Summary:
createExclude,   createInclude,   execute,   setDefaultexcludes,   setDestdir,   setExcludes,   setExportClasses,   setExportDebugInfo,   setExportResources,   setExportSources,   setIncludes,   setOverwrite

Methods from org.apache.tools.ant.taskdefs.optional.ide.VAJTask:
getUtil,   setHaltonerror,   setRemote

Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType

Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.tools.ant.taskdefs.optional.ide.VAJExport Detail:
public PatternSet.NameEntry createExclude() { return patternSet.createExclude(); } add a name entry on the exclude list
public PatternSet.NameEntry createInclude() { return patternSet.createInclude(); } add a name entry on the include list
public void execute() throws BuildException { // first off, make sure that we've got a destdir if (destDir == null) { throw new BuildException("destdir attribute must be set!"); } // delegate the export to the VAJUtil object. try { getUtil().exportPackages(destDir, patternSet.getIncludePatterns(getProject()), patternSet.getExcludePatterns(getProject()), exportClasses, exportDebugInfo, exportResources, exportSources, useDefaultExcludes, overwrite); } catch (BuildException ex) { if (haltOnError) { throw ex; } else { log(ex.toString()); } } } do the export
public void setDefaultexcludes(boolean useDefaultExcludes) { this.useDefaultExcludes = useDefaultExcludes; } Sets whether default exclusions should be used or not; default true.
public void setDestdir(File destDir) { this.destDir = destDir; } Set the destination directory into which the selected items should be exported; required.
public void setExcludes(String excludes) { patternSet.setExcludes(excludes); } Sets the set of exclude patterns. Patterns may be separated by a comma or a space. Currently only patterns denoting packages are supported
public void setExportClasses(boolean doExport) { exportClasses = doExport; } optional flag to export the class files; default false.
public void setExportDebugInfo(boolean doExport) { exportDebugInfo = doExport; } optional flag to export the debug info; default false. debug info
public void setExportResources(boolean doExport) { exportResources = doExport; } optional flag to export the resource file; default true.
public void setExportSources(boolean doExport) { exportSources = doExport; } optional flag to export the Java files; default true.
public void setIncludes(String includes) { patternSet.setIncludes(includes); } Sets the set of include patterns. Patterns may be separated by a comma or a space. Currently only patterns denoting packages are supported
public void setOverwrite(boolean doOverwrite) { overwrite = doOverwrite; } if Overwrite is set, files will be overwritten during export