create changelog entry
[debian/openrocket] / core / src / net / sf / openrocket / plugin / Configurable.java
1 package net.sf.openrocket.plugin;
2
3 public interface Configurable {
4         
5         
6         /**
7          * Return the plugin ID.  This is a text string uniquely identifying this plugin.
8          * The recommended format is similar to the fully-qualified class name of the
9          * plugin, though a shorter format starting with the developer's domain name
10          * is also possible for future compatibility.
11          * 
12          * @return      the plugin ID
13          */
14         public String getPluginID();
15         
16         /**
17          * Test whether this plugin provides functionality corresponding to the specified
18          * plugin ID.  This provides backwards compatibility if the plugin ID should change.
19          * 
20          * @param pluginID      the plugin ID to test
21          * @return                      whether this plugin provides the requested functionality
22          */
23         public boolean isCompatible(String pluginID);
24         
25         public void loadFromXML(Object... objects);
26         
27         public void saveToXML(Object... objects);
28         
29 }