home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / BuildListener.java < prev    next >
Text File  |  1998-10-25  |  2KB  |  50 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi;
  6.  
  7. /**
  8.  * The listener interface for receiving notification about the status of a <code>VisualProject</code>'s
  9.  * build.
  10.  * To be notified of changes, a plug-in implements this interface then calls
  11.  * <code>BuildManager.addBuildListener</code> to place itself on the notification list.  When
  12.  * the build status changes, the appropriate method of this interface is called.
  13.  * If you are only interested in a subset of the notification methods, you can extend the
  14.  * <code>BuildAdapter</code> class rather than implement all the methods yourself.
  15.  *
  16.  * @see VisualProject#getBuildManager
  17.  * @see BuildManager#addBuildListener
  18.  * @see BuildAdapter
  19.  *
  20.  * @author Symantec Internet Tools Division
  21.  * @version 1.0
  22.  * @since VCafe 3.0
  23.  */
  24. public interface BuildListener
  25. {
  26.     /**
  27.      * Invoked when a project build commences.
  28.      * @param visualProject    the project that is being built.
  29.      */
  30.     public void aboutToBuildProject(VisualProject visualProject);
  31.     
  32.         /** Indicates that a build completed normally. */
  33.         public final int BUILD_FINISHED = 0;
  34.         /** Indicates that the user cancelled a build. */
  35.         public final int BUILD_CANCELLED = 1;
  36.         /** Indicates that a build failed. */
  37.         public final int BUILD_FAILED = 2;
  38.  
  39.     /**
  40.      * Invoked when the project build finishes.
  41.      * @param visualProject    the project that was being built.
  42.      * @param howFinished    how the build finished.  Can be one of:<ul type=circle>
  43.      * <li>BUILD_FINISHED - the build completed normally,
  44.      * <li>BUILD_CANCELLED - the user cancelled the build, or
  45.      * <li>BUILD_FAILED - the build failed.
  46.      * </ul>
  47.      */
  48.     public void doneBuildingProject(VisualProject visualProject, int howFinished);
  49. }
  50.