1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*
* Copyright (C) 2001-2013 Michael Fuchs
*
* This file is part of herold.
*
* herold is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* herold is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with herold. If not, see <http://www.gnu.org/licenses/>.
*/
package org.dbdoclet.progress;
/**
* Die Klasse <code>ProgressEvent</code> wird dazu verwendet um interessierte
* Objekte über den Fortschritt einer Aktion zu unterrichten.
*/
public class ProgressEvent {
public static final int STAGE_PREPARE = 1;
public static final int STAGE_ACTION = 2;
private boolean consider = true;
private int max = -1;
private int index = -1;
private int stage = STAGE_ACTION;
private String action = "";
private String item = "";
private Object userObject = null;
/**
* Erzeugt ein leeres Forschrittsobjekt.
*/
public ProgressEvent() {
this(-1, -1, "", "", true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param action Die Aktionsbeschreibung.
*/
public ProgressEvent(String action) {
this(-1, -1, "", action, true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* Der Parameter <code>consider</code> gibt an, ob das Ereignis in die
* Berechnung des Fortschrittswertes eingehen soll oder nicht.
*
* @param action Die Aktionsbeschreibung.
* @param consider Schalter für die Gewichtung des Ereignisses.
*/
public ProgressEvent(String action, boolean consider) {
this(-1, -1, "", action, consider);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param item Beschreibung des verarbeiteten Objekts
* @param action Aktionsbeschreibung.
*/
public ProgressEvent(String item, String action) {
this(-1, -1, item, action, true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param index Index des Fortschrittswertes.
* @param item Beschreibung des verarbeiteten Objekts.
* @param action Aktionsbeschreibung.
*/
public ProgressEvent(int index, String item, String action) {
this(-1, index, item, action, true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param max Maximalwert des Fortschrittswertes
* @param index Aktueller Wert des Fortschrittswertes.
*/
public ProgressEvent(int max, int index) {
this(max, index, "", "", true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param max Maximalwert des Fortschrittswertes
* @param index Aktueller Wert des Fortschrittswertes.
* @param item Beschreibung des verarbeiteten Objekts.
* @param action Aktionsbeschreibung.
*/
public ProgressEvent(int max, int index, String item, String action) {
this(max, index, item, action, true);
}
/**
* Erzeugt ein Fortschrittsobjekt.
*
* @param max Maximalwert des Fortschrittswertes
* @param index Aktueller Wert des Fortschrittswertes.
* @param item Beschreibung des verarbeiteten Objekts.
* @param action Aktionsbeschreibung.
*/
public ProgressEvent(int max, int index, String item, String action, boolean consider) {
this.max = max;
this.index = index;
this.item = item;
this.action = action;
this.consider = consider;
}
public int getMax() {
return max;
}
public int getIndex() {
return index;
}
public void setItem(String item) {
this.item = item;
}
public String getItem() {
return item;
}
public void setConsider(boolean consider) {
this.consider = consider;
}
public boolean getConsider() {
return consider;
}
public String getAction() {
return action;
}
public void setAction(String action) {
this.action = action;
}
public ProgressEvent setStage(int stage) {
this.stage = stage;
return this;
}
public int getStage() {
return stage;
}
/**
* Setzt ein benutzerdefiniertes Objekt.
*/
public ProgressEvent setUserObject(Object userObject) {
this.userObject = userObject;
return this;
}
/**
* Liefert das benutzerdefinierte Objekt.
*/
public Object getUserObject() {
return userObject;
}
public String toString() {
StringBuilder buffer = new StringBuilder();
buffer.append(getAction());
return buffer.toString();
}
}
|
