01: //The contents of this file are subject to the Mozilla Public License Version 1.1
02: //(the "License"); you may not use this file except in compliance with the
03: //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
04: //
05: //Software distributed under the License is distributed on an "AS IS" basis,
06: //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
07: //for the specific language governing rights and
08: //limitations under the License.
09: //
10: //The Original Code is "The Columba Project"
11: //
12: //The Initial Developers of the Original Code are Frederik Dietz and Timo Stich.
13: //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
14: //
15: //All Rights Reserved.
16: package org.columba.core.gui.externaltools;
17:
18: import java.io.File;
19: import java.net.URL;
20:
21: import org.columba.api.plugin.IExtensionInterface;
22:
23: /**
24: * Provides easy configuration for external tools.
25: *
26: * @author fdietz
27: */
28: public abstract class AbstractExternalToolsPlugin implements
29: IExtensionInterface {
30: public AbstractExternalToolsPlugin() {
31: }
32:
33: /**
34: * Gets the path to the commandline tool.
35: * <p>
36: * If this method returns "null", a dialog will ask the user the location of
37: * the tool
38: *
39: * @return path to external tool, or "null" if tool can't be located
40: * automatically
41: */
42: public File locate() {
43: return null;
44: }
45:
46: /**
47: * Gets description which should be presented to the user.
48: *
49: * @return description of external tool
50: */
51: public abstract String getDescription();
52:
53: /**
54: * Gets web address of this tool.
55: * <p>
56: * This will be presented to the user as clickable Hyperlink in the
57: * configuration wizard.
58: *
59: * @return website of this tool
60: */
61: public abstract URL getWebsite();
62: }
|