| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Patch |
|
| 1.0;1 |
| 1 | package org.jtheque.core.managers.patch; | |
| 2 | ||
| 3 | /* | |
| 4 | * This file is part of JTheque. | |
| 5 | * | |
| 6 | * JTheque is free software: you can redistribute it and/or modify | |
| 7 | * it under the terms of the GNU General Public License as published by | |
| 8 | * the Free Software Foundation, either version 3 of the License. | |
| 9 | * | |
| 10 | * JTheque is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 | * GNU General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU General Public License | |
| 16 | * along with JTheque. If not, see <http://www.gnu.org/licenses/>. | |
| 17 | */ | |
| 18 | ||
| 19 | import org.jtheque.utils.bean.Version; | |
| 20 | ||
| 21 | /** | |
| 22 | * A patch. | |
| 23 | * | |
| 24 | * @author Baptiste Wicht | |
| 25 | */ | |
| 26 | public interface Patch { | |
| 27 | /** | |
| 28 | * Indicate if the patch must be applied for a specific version of JTheque. | |
| 29 | * | |
| 30 | * @param version The version of JTheque. | |
| 31 | * @return true if the patch must be applied for this version else false. | |
| 32 | */ | |
| 33 | boolean mustBeAppliedFor(Version version); | |
| 34 | ||
| 35 | /** | |
| 36 | * Indicate if the patch has already been applied or not. | |
| 37 | * | |
| 38 | * @return true if the patch has already been applied. | |
| 39 | */ | |
| 40 | boolean hasAlreadyBeenApplied(); | |
| 41 | ||
| 42 | /** | |
| 43 | * Apply the patch. | |
| 44 | * | |
| 45 | * @return The apply code. | |
| 46 | */ | |
| 47 | int apply(); | |
| 48 | ||
| 49 | /** | |
| 50 | * Return the name of the patch. . | |
| 51 | * | |
| 52 | * @return The name of the patch. | |
| 53 | */ | |
| 54 | String getName(); | |
| 55 | } |