AbstractExternalToolsPlugin


1   //The contents of this file are subject to the Mozilla Public License Version 1.1
2   //(the "License"); you may not use this file except in compliance with the 
3   //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
4   //
5   //Software distributed under the License is distributed on an "AS IS" basis,
6   //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
7   //for the specific language governing rights and
8   //limitations under the License.
9   //
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 IExtensionInterface {
29      public AbstractExternalToolsPlugin() {
30      }
31  
32      /**
33       * Gets the path to the commandline tool.
34       * <p>
35       * If this method returns "null", a dialog will ask the user the location of
36       * the tool
37       * 
38       * @return path to external tool, or "null" if tool can't be located
39       *         automatically
40       */
41      public File   locate() {
42          return null;
43      }
44  
45      /**
46       * Gets description which should be presented to the user.
47       * 
48       * @return description of external tool
49       */
50      public abstract String   getDescription();
51  
52      /**
53       * Gets web address of this tool.
54       * <p>
55       * This will be presented to the user as clickable Hyperlink in the
56       * configuration wizard.
57       * 
58       * @return website of this tool
59       */
60      public abstract URL   getWebsite();
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags