KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > ajde > BuildProgressMonitor


1
2 /* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
3  *
4  * This file is part of the IDE support for the AspectJ(tm)
5  * programming language; see http://aspectj.org
6  *
7  * The contents of this file are subject to the Mozilla Public License
8  * Version 1.1 (the "License"); you may not use this file except in
9  * compliance with the License. You may obtain a copy of the License at
10  * either http://www.mozilla.org/MPL/ or http://aspectj.org/MPL/.
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * The Original Code is AspectJ.
18  *
19  * The Initial Developer of the Original Code is Xerox Corporation. Portions
20  * created by Xerox Corporation are Copyright (C) 1999-2002 Xerox Corporation.
21  * All Rights Reserved.
22  *
23  * Contributor(s):
24  */
25
26
27 package org.aspectj.ajde;
28
29 /**
30  * This interface should be implemented by a progress monitor that that presents
31  * the user with the current state of the compile and estimated finish.
32  *
33  * @author Mik Kersten
34  */
35 public interface BuildProgressMonitor {
36
37     /**
38      * The heading that should be used in the title of the progress monitor.
39      */
40     public static final String JavaDoc PROGRESS_HEADING = "AspectJ Build";
41
42     /**
43      * Start the progress monitor.
44      */
45     public void start(String JavaDoc configFile);
46
47     /**
48      * Sets the label describing the current progress phase.
49      */
50     public void setProgressText(String JavaDoc text);
51
52     /**
53      * Jumps the progress bar to <CODE>newVal</CODE>.
54      */
55     public void setProgressBarVal(int newVal);
56
57     /**
58      * Makes the progress bar by one.
59      */
60     public void incrementProgressBarVal();
61
62     /**
63      * @param maxVal sets the value at which the progress will finish.
64      */
65     public void setProgressBarMax(int maxVal);
66
67     /**
68      * @return the value at which the progress monitoring will finish.
69      */
70     public int getProgressBarMax();
71
72     /**
73      * Jump the progress bar to the end and finish progress monitoring.
74      */
75     public void finish();
76 }
77
Popular Tags