1 package net.sourceforge.argval.utils;
2
3
4 import java.io.File;
5 import java.io.FileNotFoundException;
6
7 import net.sourceforge.argval.utils.impl.PropertyLocatedFile;
8
9
10 /**
11 * Locates a File. Implementing classes may contain rules, for locating the file.
12 * A message can be gotten, which gives the details, why this file was returned.
13 *
14 * @see PropertyLocatedFile
15 *
16 * @author T. Verhagen
17 */
18 public interface LocateFile {
19
20 /**
21 * Returns the File instance.
22 * @return The File instance.
23 * @throws FileNotFoundException Is thrown in the case the file is not found.
24 */
25 File getFile() throws FileNotFoundException;
26
27
28 /**
29 * Returns a message about how the file was located.
30 * @return A message about how the file was located.
31 */
32 String getFileMessage();
33
34 }