All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class buildtools.Builder

java.lang.Object
   |
   +----org.gjt.sp.jedit.EditPlugin
           |
           +----org.gjt.sp.jedit.EBPlugin
                   |
                   +----buildtools.Builder

public abstract class Builder
extends EBPlugin
builders must be plugins. This is because the ProjectManager uses querys edit for all subclass from this to create a builder


Variable Index

 o builderListTag

Constructor Index

 o Builder()

Method Index

 o build(Enumeration, String, BuildOptions, BuildProgressListener)
given a list of files, compile them to targets.
 o createBuildOptionsPane(BuildOptions)
I assume that we will not use JPanels for options pane
 o getBuilderName()
for each builder in the universe this must give a unique name.
 o getBuildType()
 o getDefaultBuildOptions()
this returns a default build options for a given builder.
 o hasGeneratedErrors()
Return true here if the builder generated an exception while compiling files.
 o removeAllTargets(String, BuildOptions)
 o removeTargets(Enumeration, String, BuildOptions)
This will be called by ProjectManager when a build all is required.

Variables

 o builderListTag
 public static final Object builderListTag

Constructors

 o Builder
 public Builder()

Methods

 o getBuildType
 public abstract String getBuildType()
Returns:
the type that this Builder builds. Should only be one type (for now!!) example "java" or "pl" this should be the file extention
 o getBuilderName
 public abstract String getBuilderName()
for each builder in the universe this must give a unique name. Override it if you want: especially useful if you think you may change the classname!

 o getDefaultBuildOptions
 public BuildOptions getDefaultBuildOptions()
this returns a default build options for a given builder. the parameters are not guarenteed to be setup correctly. You can think of this as a factory for those of you who want to implement their own entire subclass of BuildOptions. This is called every time the BuildOptions

 o build
 public abstract Vector build(Enumeration files,
                              String targetDir,
                              BuildOptions bo,
                              BuildProgressListener buildListener)
given a list of files, compile them to targets. note that build all is equivalent to removeTargets (probably better to call removeAllTargets) and build if buildListener is null then it does not give feedback destDir may be a jar file if it is desired!

 o removeTargets
 public void removeTargets(Enumeration files,
                           String targetDir,
                           BuildOptions bo)
This will be called by ProjectManager when a build all is required. The default behavior is to just remove all targets in the location, though who knows?

 o removeAllTargets
 public abstract void removeAllTargets(String targetDir,
                                       BuildOptions bo)
 o createBuildOptionsPane
 public abstract OptionPane createBuildOptionsPane(BuildOptions options)
I assume that we will not use JPanels for options pane

 o hasGeneratedErrors
 public boolean hasGeneratedErrors()
Return true here if the builder generated an exception while compiling files.


All Packages  Class Hierarchy  This Package  Previous  Next  Index