Where Am I? Class Hierarchy All Classes All Fields and Methods

Class com.ibm.ivj.util.base.ExportCodeSpec

java.lang.Object
   |
   +----com.ibm.ivj.util.base.ExportCodeSpec

public class ExportCodeSpec
extends Object
implements Serializable

This is a "helper" class used to encapsulate the export selections. It is used for base code-level export (.java, .class, resources).


Constructor Index

ExportCodeSpec()
Default constructor

Method Index

getExportDirectory()
Returns the directory path for the exported code
getPackages()
Returns the selected packages.
getProjects()
Returns the selected projects Selecting a project causes all contained types in all contained packages to be exported.
getTypes()
Returns the selected types
includeClass()
Returns true if .class files are to be exported
includeClass(boolean)
Indicate if .class files are to be exported
includeClassDebugInfo()
Returns true if exported .class files are to contain debug information.
includeClassDebugInfo(boolean)
Indicate if .class debug info is to be extported.
includeJava()
Returns true if .java files are to be exported
includeJava(boolean)
Indicate if .java files are to be exported
includeResources()
Returns true if the resource files associated with all the selected projects are to be exported.
includeResources(boolean)
Indicate if resources associated with selected project(s) are to be exported.
overwriteFiles()
Returns true if existing files are to be overwritten on export
overwriteFiles(boolean)
Indicate if existing files are to be overwritten on export
setExportDirectory(String)
Indicates a directory path to be used for export
setPackages(Package[])
Set the selected packages.
setProjects(Project[])
Set the selected projects.
setTypes(Type[])
Set the selected types.
useSubdirectories()
Returns true if export is to create a subdirectory tree (in the export directory) corresponding to the package structure of the types being exported.
useSubdirectories(boolean)
Indicate if subdirectories (corresponding to the package structure) are to be created on export

Constructors

ExportCodeSpec
 public ExportCodeSpec()
Default constructor


Methods

getExportDirectory
 public String getExportDirectory()
Returns the directory path for the exported code

Returns:
java.lang.String
getPackages
 public Package[] getPackages()
Returns the selected packages. Selecting a package causes all contained types to be exported.

Returns:
com.ibm.ivj.util.base.Package[]
getProjects
 public Project[] getProjects()
Returns the selected projects Selecting a project causes all contained types in all contained packages to be exported.

Returns:
com.ibm.ivj.util.base.Project[]
getTypes
 public Type[] getTypes()
Returns the selected types

Returns:
com.ibm.ivj.util.base.Type[]
includeClass
 public boolean includeClass()
Returns true if .class files are to be exported

Returns:
boolean
includeClass
 public void includeClass(boolean setting)
Indicate if .class files are to be exported

Parameters:
setting - boolean
includeClassDebugInfo
 public boolean includeClassDebugInfo()
Returns true if exported .class files are to contain debug information. Note, that if includeClass() returns false, this method always returns false regardless of the debug setting

Returns:
boolean
includeClassDebugInfo
 public void includeClassDebugInfo(boolean setting)
Indicate if .class debug info is to be extported. includeClass(true) must also be set.

Parameters:
setting - boolean
includeJava
 public boolean includeJava()
Returns true if .java files are to be exported

Returns:
boolean
includeJava
 public void includeJava(boolean setting)
Indicate if .java files are to be exported

Parameters:
setting - boolean
includeResources
 public boolean includeResources()
Returns true if the resource files associated with all the selected projects are to be exported. A project is considered "selected" if it is explicitly indicated (setProjects()), or is the containing project for the indicated packages and/or types.

Returns:
boolean
includeResources
 public void includeResources(boolean setting)
Indicate if resources associated with selected project(s) are to be exported. A project is considered "selected" if it is explicitly indicated (setProjects()), or is the containing project for the indicated packages and/or types.

Parameters:
setting - boolean
overwriteFiles
 public boolean overwriteFiles()
Returns true if existing files are to be overwritten on export

Returns:
boolean
overwriteFiles
 public void overwriteFiles(boolean setting)
Indicate if existing files are to be overwritten on export

Parameters:
setting - boolean
setExportDirectory
 public void setExportDirectory(String path)
Indicates a directory path to be used for export

Parameters:
path - java.lang.String
setPackages
 public void setPackages(Package packages[])
Set the selected packages. Note, that the project, package and type selection are independent (ie. one does not qualify the other). The total set of types in the specified projects, packages and types is exported

Parameters:
projects - com.ibm.ivj.util.base.Package[]
setProjects
 public void setProjects(Project projects[])
Set the selected projects. Note, that the project, package and type selection are independent (ie. one does not qualify the other). The total set of types in the specified projects, packages and types is extracted.

Parameters:
projects - com.ibm.ivj.util.base.Project[]
setTypes
 public void setTypes(Type types[])
Set the selected types. Note, that the project, package and type selection are independent (ie. one does not qualify the other). The total set of types in the specified projects, packages and types is extracted.

Parameters:
projects - com.ibm.ivj.util.base.Type[]
useSubdirectories
 public boolean useSubdirectories()
Returns true if export is to create a subdirectory tree (in the export directory) corresponding to the package structure of the types being exported. Returns false if the files are to be exported directly into the specified directory

Returns:
boolean
useSubdirectories
 public void useSubdirectories(boolean setting)
Indicate if subdirectories (corresponding to the package structure) are to be created on export

Parameters:
setting - boolean

Where Am I? Class Hierarchy All Classes All Fields and Methods