home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / BuildManager.java < prev    next >
Text File  |  1998-10-25  |  2KB  |  60 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi;
  6.  
  7. /**
  8.  * The API used to handle build requests for a <code>VisualProject</code>.
  9.  * @see VisualProject#getBuildManager
  10.  *
  11.  * @author Symantec Internet Tools Division
  12.  * @version 1.0
  13.  * @since VCafe 3.0
  14.  */
  15. public interface BuildManager
  16. {
  17.     /**
  18.      * Builds the applet or application.  Only outdated files are compiled.
  19.      * if <code>wait</code> is <code>true</code>, return success indicates
  20.      * the project built without errors.
  21.      * @param wait if <code>false</code>, the function returns immediately, otherwise it
  22.      * waits until the build is complete.
  23.      * @return boolean <code>true</code> if success, <code>false</code> otherwise.
  24.      */
  25.     public boolean build(boolean wait);
  26.  
  27.     /**
  28.      * Builds all files in the project.
  29.      * @param wait if <code>false</code>, the function returns immediately, otherwise it
  30.      * waits until the build is complete.
  31.      * @return boolean <code>true</code> if success, <code>false</code> otherwise.
  32.      */
  33.     public boolean rebuildAll(boolean wait);
  34.     
  35.     /**
  36.      * Causes the current build to stop.
  37.      */
  38.     public void stopBuilding();
  39.     
  40.     /**
  41.      * Determines if the project is currently being built.
  42.      * @return <code>true</code> if the project is being built.
  43.      */
  44.     public boolean isBuilding();
  45.     
  46.     /**
  47.      * Adds a listener that receives project build notifications.
  48.      * @param buildListener the <code>BuildListener</code> to add.
  49.      * @see BuildListener
  50.      */
  51.     public void addBuildListener(BuildListener buildListener);
  52.  
  53.     /**
  54.      * Removes a listener that was receiving project build notifications.
  55.      * @param buildListener the <code>BuildListener</code> to remove.
  56.      * @see BuildListener
  57.      */
  58.     public void removeBuildListener(BuildListener buildListener);
  59. }
  60.