2.17.2: 2011-06-17

Class NamespacePluginParameter<T>

  extended by net.sf.basedb.core.PluginParameter<T>
      extended by net.sf.basedb.core.plugin.NamespacePluginParameter<T>

public class NamespacePluginParameter<T>
extends PluginParameter<T>

A helper class that wraps a plug-in parameter object with a namespace. The parent parameter is cloned to a parameter with the namespace pre-pended to the name. Eg, the 'name' value is replaced with the namespace + dot + the original name. For example, if namespace="export" and name="toDir", the resulting name is "export.toDir".

The main usage for this class is when a master plug-in needs to use other child plug-ins. By wrapping the child parameters with an instance of this class it makes it possible to mix parameters from several child plug-ins without having to worry about name clashes.

See Also:
NamespaceParameterValuesWrapper, NamespaceRequestWrapper
Last modified
$Date $

Field Summary
Fields inherited from class net.sf.basedb.core.PluginParameter
Constructor Summary
NamespacePluginParameter(PluginParameter<T> parent, String namespace)
          Create a new parameter wrapper for the plug-in parameter.
Method Summary
Methods inherited from class net.sf.basedb.core.PluginParameter
getDefaultValue, getDescription, getLabel, getName, getParameterType, isHidden, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public NamespacePluginParameter(PluginParameter<T> parent,
                                String namespace)
Create a new parameter wrapper for the plug-in parameter.

parent - The plug-in parameter to wrap, null is not allowed
namespace - The namespace, null is not allowed

2.17.2: 2011-06-17