| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| FileAccess |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Created on Oct 7, 2007 by wyatt | |
| 3 | */ | |
| 4 | package org.homeunix.thecave.buddi.plugin.api; | |
| 5 | ||
| 6 | public interface FileAccess { | |
| 7 | /** | |
| 8 | * Should Buddi prompt for a file to import? Defaults to true. If you know what | |
| 9 | * the file name is (or you are importing from a different source, such as the | |
| 10 | * network), you should override this method and return false. | |
| 11 | * @return | |
| 12 | */ | |
| 13 | public boolean isPromptForFile(); | |
| 14 | ||
| 15 | /** | |
| 16 | * Override to specify that Buddi should only include certain file types in | |
| 17 | * the file chooser. This only has an effect if isPromptForFile() is true. If | |
| 18 | * you want to do this, return a String array of the file extensions which you wish | |
| 19 | * to match. The plugin loader will create a FileFilter for this. | |
| 20 | * @return | |
| 21 | */ | |
| 22 | public String[] getFileExtensions(); | |
| 23 | ||
| 24 | /** | |
| 25 | * Returns the message which should show when processing the data. Defaults | |
| 26 | * to "Processing File..."; override if needed. This value is filtered through | |
| 27 | * the translator before being displayed. | |
| 28 | * @return | |
| 29 | */ | |
| 30 | public String getProcessingMessage(); | |
| 31 | ||
| 32 | /** | |
| 33 | * Return the description which shows up in the file chooser. By default, this | |
| 34 | * is set to "Buddi [Import|Export|Synchronize] Files". This value is filtered | |
| 35 | * through the translator before being displayed. | |
| 36 | */ | |
| 37 | public String getDescription(); | |
| 38 | } |