com.ibm.carma.ui
Class CustomParameterControlRegistry
java.lang.Object
com.ibm.carma.ui.CustomParameterControlRegistry
public class CustomParameterControlRegistry
- extends java.lang.Object
Registry of custom parameter controls.
The registry can be populated by the com.ibm.carma.ui.customParameterControls extension
point. Custom controls for a particular parameter in a particular RAM can be retrieved using the
#getCustomParameterControls method.
- Since:
- 8.0
|
Field Summary |
static java.lang.String |
COPYRIGHT
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- See Also:
- Constant Field Values
getRegistry
public static CustomParameterControlRegistry getRegistry()
- Returns the custom parameter control registry. If the registry has not been created,
a new instance is created and initially populated with data from the Eclipse
extension providers.
- Returns:
- the instance of the registry
getCustomParameterControl
public ICustomParameterControl getCustomParameterControl(java.lang.String ramUniqueId,
java.lang.String parameterId,
java.lang.String actionId)
- Returns the registered custom parameter control for the given RAM, parameter, and action.
While more than one custom parameter control can be defined for a given parameter, the
custom parameter registry will return only one custom parameter control when asked for one.
Preference will be given to a registered custom control whose parameter ID matches the
requested parameter ID exactly, rather than a custom control that is defined with a wildcard
as a parameter ID. If more than one of these is registered, preference will be given to
a registered custom control whose action ID matches the requested action ID exactly, rather
than a custom control that is defined with a wildcard as an action ID. If more than one of
these is registered, the registry's choice is undefined.
- Parameters:
ramUniqueId - the unique identifier of the RAMparameterId - the identifier of the parameter as defined in the RAMactionId - the identifier of the action as defined in the RAM
- Returns:
- the custom parameter control that is registered for the given parameter