Cytoscape 2.8.0 API

cytoscape.plugin
Class PluginProperties

java.lang.Object
  extended by java.util.Dictionary<K,V>
      extended by java.util.Hashtable<Object,Object>
          extended by java.util.Properties
              extended by cytoscape.plugin.PluginProperties
All Implemented Interfaces:
Serializable, Cloneable, Map<Object,Object>

public class PluginProperties
extends Properties

This class reads the plugin.props file that is expected to be in each plugin jar file and turns it into a PluginInfo object for the PluginManager

See Also:
Serialized Form

Nested Class Summary
static class PluginProperties.PluginProperty
          Properties in the plugin.props file
 
Field Summary
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
PluginProperties(CytoscapePlugin Plugin)
          The plugin.props file is expected to be in the jar file under the package directory.
 
Method Summary
 PluginInfo fillPluginInfoObject(DownloadableInfo info)
          Takes a PluginInfo object (can be null) and fills it in with information that would not come from a properties file like the unique identifier and download url.
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PluginProperties

public PluginProperties(CytoscapePlugin Plugin)
                 throws IOException
The plugin.props file is expected to be in the jar file under the package directory. It will not be found if it is anywhere else.

Parameters:
Plugin -
Throws:
IOException
Method Detail

fillPluginInfoObject

public PluginInfo fillPluginInfoObject(DownloadableInfo info)
                                throws ManagerException
Takes a PluginInfo object (can be null) and fills it in with information that would not come from a properties file like the unique identifier and download url.

Parameters:
info -
Returns:
Throws:
ManagerException

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.