Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Updatable |
|
| 1.0;1 |
1 | package org.jtheque.core.managers.update; | |
2 | ||
3 | import org.jtheque.utils.bean.Version; | |
4 | ||
5 | /* | |
6 | * This file is part of JTheque. | |
7 | * | |
8 | * JTheque is free software: you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation, either version 3 of the License. | |
11 | * | |
12 | * JTheque is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with JTheque. If not, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
21 | /** | |
22 | * An updatable. It seems an objet who can be updated externally. | |
23 | * | |
24 | * @author Baptiste Wicht | |
25 | */ | |
26 | public interface Updatable { | |
27 | /** | |
28 | * Return the name of the updatable. | |
29 | * | |
30 | * @return The name of the updatable. | |
31 | */ | |
32 | String getName(); | |
33 | ||
34 | /** | |
35 | * Return the internationalization key of the updatable. | |
36 | * | |
37 | * @return The internationalization key of the updatable. | |
38 | */ | |
39 | String getKey(); | |
40 | ||
41 | /** | |
42 | * Return the version of the updatable. | |
43 | * | |
44 | * @return The version of the updatable. | |
45 | */ | |
46 | Version getVersion(); | |
47 | ||
48 | /** | |
49 | * Return the default version of the updatable. | |
50 | * | |
51 | * @return The default version of the updatable. | |
52 | */ | |
53 | Version getDefaultVersion(); | |
54 | ||
55 | /** | |
56 | * Set the version of the updatable. | |
57 | * | |
58 | * @param version The version of the updatable. | |
59 | */ | |
60 | void setVersion(Version version); | |
61 | ||
62 | /** | |
63 | * Return the URL of the versions file. | |
64 | * | |
65 | * @return the URL of the versions file. | |
66 | */ | |
67 | String getVersionsFileURL(); | |
68 | ||
69 | /** | |
70 | * Add an update listener to the updatable. | |
71 | * | |
72 | * @param listener The listener to add. | |
73 | */ | |
74 | void addUpdateListener(UpdateListener listener); | |
75 | ||
76 | /** | |
77 | * Remove an update listener to the updatable. | |
78 | * | |
79 | * @param listener The listener to remove. | |
80 | */ | |
81 | void removeUpdateListener(UpdateListener listener); | |
82 | ||
83 | /** | |
84 | * Set the updatable as updated. | |
85 | */ | |
86 | void setUpdated(); | |
87 | } |