public final class ExtensionParameterValues extends Object implements IParameterValues, IExecutableExtension
A generic implementation of IParameterValues
that takes advantage
of the IExecutableExtension
mechanism. The parameter values and names can be
specified purely in XML. This can be done as follows:
<command
name="%name"
description="%description"
categoryId="categoryId"
id="commandId">
<parameter
id="parameterId"
name="%parameterName">
<values class="org.eclipse.ui.commands.ExtensionParameterValues">
<parameter name="%parameterName1" value="parameterValue1" />
<parameter name="%parameterName2" value="parameterValue2" />
<parameter name="%parameterName3" value="parameterValue3" />
</values>
</parameter>
</command>
Modifier and Type | Field and Description |
---|---|
static String |
DELIMITER
The delimiter between elements if the name-value pairs are specified in a
single string.
|
Constructor and Description |
---|
ExtensionParameterValues() |
Modifier and Type | Method and Description |
---|---|
Map |
getParameterValues()
Returns a map keyed by externalized names for parameter values.
|
void |
setInitializationData(IConfigurationElement config,
String propertyName,
Object data)
This method is called by the implementation of the method
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. |
public static final String DELIMITER
public Map getParameterValues()
IParameterValues
getParameterValues
in interface IParameterValues
String
)
to the actual value of the parameter (String
).public final void setInitializationData(IConfigurationElement config, String propertyName, Object data)
IExecutableExtension
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. Most executable extensions only make use of the first
two call arguments.
Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>In the above example, this method would be called with a reference to the
<action>
element (first argument), and
"run"
as the name of the attribute that defined
this executable extension (second argument).
The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation
class attribute value. The Java class name can be followed
by a ":" separator, followed by any adapter data in string
form. For example, if the extension point specifies an attribute
"run"
to contain the name of the extension implementation,
an adapter can be configured as
<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action> <run class="com.xyz.ExternalAdapter"> <parameter name="exec" value="./cmds/util.exe"/> <parameter name="opt" value="3"/> </run > </action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null
, if no adapter data was suppliedString
Hashtable
containing the actual
parameter names and values (both String
s)setInitializationData
in interface IExecutableExtension
config
- the configuration element used to trigger this execution.
It can be queried by the executable extension for specific
configuration propertiespropertyName
- the name of an attribute of the configuration element
used on the createExecutableExtension(String)
call. This
argument can be used in the cases where a single configuration element
is used to define multiple executable extensions.data
- adapter data in the form of a String
,
a Hashtable
, or null
.IConfigurationElement.createExecutableExtension(String)
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.