net.sf.jabref.plugin.util

Class RuntimeExtension

java.lang.Object

net.sf.jabref.plugin.util.ParameterAccessor

net.sf.jabref.plugin.util.RuntimeExtension

All Implemented Interfaces:

org.java.plugin.registry.Documentable<org.java.plugin.registry.Extension>, org.java.plugin.registry.Extension, org.java.plugin.registry.Identity, org.java.plugin.registry.PluginElement<org.java.plugin.registry.Extension>, org.java.plugin.registry.UniqueIdentity

public class RuntimeExtension
extends ParameterAccessor
implements org.java.plugin.registry.Extension

Helper class to wrap an existing extension for use in a plugin. Generated plug-in code will extend this class and put all calls through to the wrapped extension instance.

Nested Class Summary

Nested classes/interfaces inherited from interface org.java.plugin.registry.Extension

org.java.plugin.registry.Extension.Parameter

Constructor Summary

Constructors

Constructor and Description
RuntimeExtension(org.java.plugin.Plugin declaringPlugin, org.java.plugin.registry.Extension wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
org.java.plugin.Plugin	getDeclaringPlugin() If subclasses extend ParameterAccessor they should provide the plugin instance here from which to query the parameter.
org.java.plugin.registry.PluginDescriptor	getDeclaringPluginDescriptor()
org.java.plugin.registry.PluginFragment	getDeclaringPluginFragment()
java.lang.String	getDocsPath()
org.java.plugin.registry.Documentation<org.java.plugin.registry.Extension>	getDocumentation()
java.lang.String	getExtendedPluginId()
java.lang.String	getExtendedPointId()
java.lang.String	getId()
org.java.plugin.registry.Extension.Parameter	getParameter(java.lang.String id) Should return the parameter for this accessor with the given id.
java.util.Collection<org.java.plugin.registry.Extension.Parameter>	getParameters() Should get all parameters for this accessor.
java.util.Collection<org.java.plugin.registry.Extension.Parameter>	getParameters(java.lang.String id) Should return all parameters for this accessor with the given id.
java.lang.String	getUniqueId()
boolean	isValid()

Methods inherited from class net.sf.jabref.plugin.util.ParameterAccessor

getBooleanParameter, getBooleanParameters, getClassParameter, getClassParameters, getDateParameter, getDateParameters, getNumberParameter, getNumberParameters, getResourceParameter, getResourceParameter, getResourceParameters, getResourceParameters, getStringParameter, getStringParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuntimeExtension

public RuntimeExtension(org.java.plugin.Plugin declaringPlugin,
                org.java.plugin.registry.Extension wrapped)

Method Detail

getDeclaringPlugin

public org.java.plugin.Plugin getDeclaringPlugin()

Description copied from class: ParameterAccessor

If subclasses extend ParameterAccessor they should provide the plugin instance here from which to query the parameter.

Specified by:

getDeclaringPlugin in class ParameterAccessor

Returns:

The plugin that this parameter belongs to.

getExtendedPluginId

public java.lang.String getExtendedPluginId()

Specified by:

getExtendedPluginId in interface org.java.plugin.registry.Extension

getExtendedPointId

public java.lang.String getExtendedPointId()

Specified by:

getExtendedPointId in interface org.java.plugin.registry.Extension

getParameter

public org.java.plugin.registry.Extension.Parameter getParameter(java.lang.String id)

Description copied from class: ParameterAccessor

Should return the parameter for this accessor with the given id.

Specified by:

getParameter in interface org.java.plugin.registry.Extension

Specified by:

getParameter in class ParameterAccessor

Returns:

Will throw an exception if more than parameter is found with the given id. Use getParameters then.

getParameters

public java.util.Collection<org.java.plugin.registry.Extension.Parameter> getParameters()

Description copied from class: ParameterAccessor

Should get all parameters for this accessor.

Specified by:

getParameters in interface org.java.plugin.registry.Extension

Specified by:

getParameters in class ParameterAccessor

getParameters

public java.util.Collection<org.java.plugin.registry.Extension.Parameter> getParameters(java.lang.String id)

Description copied from class: ParameterAccessor

Should return all parameters for this accessor with the given id.

Specified by:

getParameters in interface org.java.plugin.registry.Extension

Specified by:

getParameters in class ParameterAccessor

isValid

public boolean isValid()

Specified by:

isValid in interface org.java.plugin.registry.Extension

getUniqueId

public java.lang.String getUniqueId()

Specified by:

getUniqueId in interface org.java.plugin.registry.UniqueIdentity

getId

public java.lang.String getId()

Specified by:

getId in interface org.java.plugin.registry.Identity

Specified by:

getId in class ParameterAccessor

getDeclaringPluginDescriptor

public org.java.plugin.registry.PluginDescriptor getDeclaringPluginDescriptor()

Specified by:

getDeclaringPluginDescriptor in interface org.java.plugin.registry.PluginElement<org.java.plugin.registry.Extension>

getDeclaringPluginFragment

public org.java.plugin.registry.PluginFragment getDeclaringPluginFragment()

Specified by:

getDeclaringPluginFragment in interface org.java.plugin.registry.PluginElement<org.java.plugin.registry.Extension>

getDocsPath

public java.lang.String getDocsPath()

Specified by:

getDocsPath in interface org.java.plugin.registry.Documentable<org.java.plugin.registry.Extension>

getDocumentation

public org.java.plugin.registry.Documentation<org.java.plugin.registry.Extension> getDocumentation()

Specified by:

getDocumentation in interface org.java.plugin.registry.Documentable<org.java.plugin.registry.Extension>