net.sf.jabref.plugin.util

Class SubParameterAccessor

java.lang.Object

net.sf.jabref.plugin.util.ParameterAccessor

net.sf.jabref.plugin.util.SubParameterAccessor

public class SubParameterAccessor
extends ParameterAccessor

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

Constructor Summary

Constructors

Constructor and Description
SubParameterAccessor(org.java.plugin.Plugin declaringPlugin, org.java.plugin.registry.Extension.Parameter parameter)

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.
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.

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

SubParameterAccessor

public SubParameterAccessor(org.java.plugin.Plugin declaringPlugin,
                    org.java.plugin.registry.Extension.Parameter parameter)

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.

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 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 class ParameterAccessor

Returns:

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 class ParameterAccessor

Returns:

getId

public java.lang.String getId()

Specified by:

getId in class ParameterAccessor