| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Importer |
|
| 1.0;1 |
| 1 | package org.jtheque.films.services.impl.utils.file.imports; | |
| 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.films.utils.Constants.Files.FileType; | |
| 20 | import org.jtheque.utils.io.FileException; | |
| 21 | ||
| 22 | /** | |
| 23 | * An importer specification. | |
| 24 | * | |
| 25 | * @author Baptiste Wicht | |
| 26 | */ | |
| 27 | public interface Importer { | |
| 28 | /** | |
| 29 | * Indicate if the importer can import from the specified file type. | |
| 30 | * | |
| 31 | * @param fileType The file type. | |
| 32 | * @return <code>true</code> if the importer can import from this file type else <code>false</code>. | |
| 33 | */ | |
| 34 | boolean canImportFrom(FileType fileType); | |
| 35 | ||
| 36 | /** | |
| 37 | * Import all the data from the file. | |
| 38 | * | |
| 39 | * @param filePath The path to the file. | |
| 40 | * @throws FileException This exception is throwed when the import cannot be correctly. | |
| 41 | */ | |
| 42 | void importFrom(String filePath) throws FileException; | |
| 43 | } |