net.sf.basedb.core.plugin
Class NamespacePluginParameter<T>

java.lang.Object
  net.sf.basedb.core.PluginParameter<T>
      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.

Since:

2.15

Author:

nicklas

See Also:

NamespaceParameterValuesWrapper, NamespaceRequestWrapper

Last modified

$Date $

Field Summary

Fields inherited from class net.sf.basedb.core.PluginParameter

hidden

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

NamespacePluginParameter

public NamespacePluginParameter(PluginParameter<T> parent,
                                String namespace)

Create a new parameter wrapper for the plug-in parameter.

Parameters:

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

namespace - The namespace, null is not allowed