org.openptk.plugin
Interface PluginIF

All Superinterfaces:
java.lang.Comparable<org.openptk.common.ComponentIF>, org.openptk.common.ComponentIF
All Known Implementing Classes:
Plugin

public interface PluginIF
extends org.openptk.common.ComponentIF

Author:
Scott Fehrman, Sun Microsystems, Inc.

Field Summary
 
Fields inherited from interface org.openptk.common.ComponentIF
EXECUTE_BEGIN, EXECUTE_END, PROP_OPENPTK_HOME, PROP_OPENPTK_TEMP, SORT_BEGIN, SORT_END
 
Method Summary
 StructureIF execute(StructureIF structure)
           
 void shutdown()
           
 void startup()
           
 
Methods inherited from interface org.openptk.common.ComponentIF
copy, getAttribute, getAttributes, getAttributesNames, getAttributesSize, getCategory, getCategoryAsString, getDebugLevel, getDebugLevelAsInt, getDebugLevelAsString, getDescription, getProperties, getPropertiesSize, getProperty, getSortValue, getState, getStateAsString, getStatus, getTimeStamp, getTimeStampNames, getTimeStamps, getUniqueId, getUniqueIdType, isDebug, isError, isTimeStamp, setAttribute, setAttributes, setCategory, setDebug, setDebugLevel, setDescription, setError, setProperties, setProperty, setSortValue, setState, setState, setStatus, setTimeStamp, setTimeStamp, setUniqueId, setUniqueId, setUniqueId, setUniqueId, useTimeStamp
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

execute

StructureIF execute(StructureIF structure)
                    throws PluginException
Parameters:
structure -
Returns:
StructureIF
Throws:
PluginException

shutdown

void shutdown()
              throws PluginException
Throws:
PluginException

startup

void startup()
             throws PluginException
Throws:
PluginException


View/submit a bug or feature

For further API reference and developer documentation, see www.openptk.org. That documentation contains more detailed, developer-targeted descriptions, definitions of terms, workarounds, and working code examples.

Copyright (C) 2008-2012, Project OpenPTK. All Rights Reserved