Revision 1666 org.gvsig.tools/library/trunk/org.gvsig.tools/org.gvsig.tools.lib/src/main/java/org/gvsig/tools/task/SimpleTaskStatus.java
SimpleTaskStatus.java | ||
---|---|---|
26 | 26 |
public interface SimpleTaskStatus extends TaskStatus { |
27 | 27 |
|
28 | 28 |
/** |
29 |
* Used by the task to set the title associated to the task. |
|
30 |
* It can't be changed.
|
|
31 |
*
|
|
29 |
* Used by the task to set the title associated to the task. It can't be
|
|
30 |
* changed. |
|
31 |
* |
|
32 | 32 |
* @param tittle |
33 |
*
|
|
33 |
* |
|
34 | 34 |
* @deprecated @see {@link SimpleTaskStatus#setTitle(String)} |
35 | 35 |
*/ |
36 | 36 |
public void setTittle(String tittle); |
37 | 37 |
|
38 | 38 |
/** |
39 |
* Used by the task to set the title associated to the task. |
|
40 |
* It can't be changed.
|
|
41 |
*
|
|
39 |
* Used by the task to set the title associated to the task. It can't be
|
|
40 |
* changed. |
|
41 |
* |
|
42 | 42 |
* @param title |
43 | 43 |
*/ |
44 | 44 |
public void setTitle(String title); |
45 | 45 |
|
46 |
/** |
|
47 |
* Used by the task to set a message associated to the current action of the task |
|
48 |
* |
|
49 |
* @param message |
|
50 |
*/ |
|
51 |
public void message(String message); |
|
52 |
|
|
53 |
/** |
|
54 |
* Used by the task to set the value for min and max steps of the task. |
|
55 |
* These are used with the "curvalue" to calculate the |
|
56 |
* percentage of completion. |
|
57 |
* |
|
58 |
* @param min |
|
59 |
* @param max |
|
60 |
*/ |
|
46 |
/** |
|
47 |
* Used by the task to set a message associated to the current action of the |
|
48 |
* task |
|
49 |
* |
|
50 |
* @param message |
|
51 |
*/ |
|
52 |
public void message(String message); |
|
53 |
|
|
54 |
/** |
|
55 |
* Used by the task to set the value for min and max steps of the task. |
|
56 |
* These are used with the "curvalue" to calculate the percentage of |
|
57 |
* completion. |
|
58 |
* |
|
59 |
* @param min |
|
60 |
* @param max |
|
61 |
*/ |
|
61 | 62 |
public void setRangeOfValues(long min, long max); |
62 | 63 |
|
63 | 64 |
/** |
64 |
* Used by the task to set the current step of the task.
|
|
65 |
*
|
|
66 |
* @param value
|
|
67 |
* @see setRangeOfValues
|
|
68 |
*
|
|
69 |
*/
|
|
70 |
public void setCurValue(long value);
|
|
65 |
* Used by the task to set the current step of the task.
|
|
66 |
*
|
|
67 |
* @param value
|
|
68 |
* @see setRangeOfValues
|
|
69 |
*
|
|
70 |
*/
|
|
71 |
public void setCurValue(long value);
|
|
71 | 72 |
|
72 |
/**
|
|
73 |
* Used by the task to inform that it has terminated without errors.
|
|
74 |
*/
|
|
75 |
public void terminate();
|
|
73 |
/**
|
|
74 |
* Used by the task to inform that it has terminated without errors.
|
|
75 |
*/
|
|
76 |
public void terminate();
|
|
76 | 77 |
|
77 |
/**
|
|
78 |
* Used by the task to inform that it has terminated cancelled by the user
|
|
79 |
* or another task.
|
|
80 |
*/
|
|
81 |
public void cancel();
|
|
78 |
/**
|
|
79 |
* Used by the task to inform that it has terminated cancelled by the user
|
|
80 |
* or another task.
|
|
81 |
*/
|
|
82 |
public void cancel();
|
|
82 | 83 |
|
83 |
/**
|
|
84 |
* Used by the task to inform that it has terminated with errors.
|
|
85 |
*/
|
|
86 |
public void abort();
|
|
84 |
/**
|
|
85 |
* Used by the task to inform that it has terminated with errors.
|
|
86 |
*/
|
|
87 |
public void abort();
|
|
87 | 88 |
|
88 |
/** |
|
89 |
* Remove this TaskStatus from the TaskStatusManager |
|
90 |
*/ |
|
91 |
public void remove(); |
|
92 |
|
|
93 |
/** |
|
94 |
* Add this TaskStatus to the TaskStatusManager. |
|
95 |
* If TaskStatus already in the manager this is updated. |
|
96 |
*/ |
|
97 |
public void add(); |
|
89 |
/** |
|
90 |
* Remove this TaskStatus from the TaskStatusManager |
|
91 |
*/ |
|
92 |
public void remove(); |
|
98 | 93 |
|
99 |
/** |
|
100 |
* Used by the task to inform that this task es cacellable. |
|
101 |
* |
|
102 |
* @param cancellable |
|
103 |
*/ |
|
104 |
public void setCancellable(boolean cancellable); |
|
94 |
/** |
|
95 |
* Add this TaskStatus to the TaskStatusManager. If TaskStatus already in |
|
96 |
* the manager this is updated. |
|
97 |
*/ |
|
98 |
public void add(); |
|
105 | 99 |
|
106 |
/** |
|
107 |
* Used by the task to inform that this TaskStatus is removed |
|
108 |
* from the manager automatically when the task is terminated and the manager |
|
109 |
* need. |
|
110 |
* |
|
111 |
* @param autoremove |
|
112 |
*/ |
|
113 |
public void setAutoremove(boolean autoremove); |
|
114 |
|
|
115 |
/** |
|
116 |
* Return the autoremove value of this TaskStatus. |
|
117 |
* |
|
118 |
* @return |
|
119 |
*/ |
|
120 |
public boolean getAutoRemove(); |
|
121 |
|
|
122 |
|
|
123 |
/** |
|
124 |
* Set the estatus of task to inteterminate. |
|
125 |
* Reset values of range and current value. |
|
126 |
* |
|
127 |
* @param Indeterminate |
|
128 |
*/ |
|
129 |
public void setIndeterminate(); |
|
130 |
|
|
131 |
/** |
|
132 |
* Este metodo guarda los valores de progreso y el mensaje de la tarea |
|
133 |
* para ser restaurados posteriormente invocando al metodo {@link #pop()}. |
|
134 |
* |
|
135 |
* Los metodos {@link #push()} y {@link #pop()} estan pensado para gestionar |
|
136 |
* subtareas dentro de un tareas, de forma que las subtareas puedan tener su |
|
100 |
/** |
|
101 |
* Used by the task to inform that this task es cacellable. |
|
102 |
* |
|
103 |
* @param cancellable |
|
104 |
*/ |
|
105 |
public void setCancellable(boolean cancellable); |
|
106 |
|
|
107 |
/** |
|
108 |
* Used by the task to inform that this TaskStatus is removed from the |
|
109 |
* manager automatically when the task is terminated and the manager need. |
|
110 |
* |
|
111 |
* @param autoremove |
|
112 |
*/ |
|
113 |
public void setAutoremove(boolean autoremove); |
|
114 |
|
|
115 |
/** |
|
116 |
* Return the autoremove value of this TaskStatus. |
|
117 |
* |
|
118 |
* @return |
|
119 |
*/ |
|
120 |
public boolean getAutoRemove(); |
|
121 |
|
|
122 |
/** |
|
123 |
* Set the estatus of task to inteterminate. Reset values of range and |
|
124 |
* current value. |
|
125 |
*/ |
|
126 |
public void setIndeterminate(); |
|
127 |
|
|
128 |
/** |
|
129 |
* Este metodo guarda los valores de progreso y el mensaje de la tarea para |
|
130 |
* ser restaurados posteriormente invocando al metodo {@link #pop()}. |
|
131 |
* |
|
132 |
* Los metodos {@link #push()} y {@link #pop()} estan pensado para gestionar |
|
133 |
* subtareas dentro de un tareas, de forma que las subtareas puedan tener su |
|
137 | 134 |
* propio progreso y mensaje mientras se estan ejecutando. |
138 |
*
|
|
135 |
* |
|
139 | 136 |
* @see {@link #pop()} |
140 |
*/ |
|
141 |
public void push(); |
|
142 |
|
|
143 |
/** |
|
144 |
* Este metodo esta pensado para restaurar los ultimos valores de progreso y |
|
145 |
* mensaje que se guardaron invocando al metodo {@link #push()}. |
|
146 |
* |
|
147 |
* @see {@link #push()} |
|
148 |
*/ |
|
149 |
public void pop(); |
|
150 |
|
|
137 |
*/ |
|
138 |
public void push(); |
|
139 |
|
|
140 |
/** |
|
141 |
* Este metodo esta pensado para restaurar los ultimos valores de progreso y |
|
142 |
* mensaje que se guardaron invocando al metodo {@link #push()}. |
|
143 |
* |
|
144 |
* @see {@link #push()} |
|
145 |
*/ |
|
146 |
public void pop(); |
|
147 |
|
|
148 |
public void restart(); |
|
151 | 149 |
} |
Also available in: Unified diff