org.apache.lenya.cms.task
Class ParameterWrapper

java.lang.Object
  org.apache.lenya.cms.task.ParameterWrapper

Direct Known Subclasses:

Notifier, TaskParameters, TaskWrapperParameters, WorkflowInvoker

public abstract class ParameterWrapper
extends java.lang.Object

Constructor Summary

ParameterWrapper(java.util.Map prefixedParameters)
Ctor.

Method Summary

java.lang.String	get(java.lang.String key) Returns the value for a key.
java.util.Map	getMap() Returns the un-prefixed parameters.
java.lang.String[]	getMissingKeys() Returns the missing parameters parameters.
abstract java.lang.String	getPrefix() Returns the namespace prefix.
protected abstract java.lang.String[]	getRequiredKeys() Returns the required keys.
boolean	isComplete() Checks if this parameters object contains all necessary parameters.
void	parameterize(org.apache.avalon.framework.parameters.Parameters parameters) Parameterizes this wrapper with un-prefixed parameters.
void	put(java.lang.String key, java.lang.String value) Adds a key-value pair.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterWrapper

public ParameterWrapper(java.util.Map prefixedParameters)

Ctor.

Parameters:

prefixedParameters - The prefixed parameters to wrap.

Method Detail

getMap

public java.util.Map getMap()

Returns the un-prefixed parameters.

Returns:

A map.

getPrefix

public abstract java.lang.String getPrefix()

Returns the namespace prefix.

Returns:

A string.

put

public void put(java.lang.String key,
                java.lang.String value)

Adds a key-value pair. If the value is null, no pair is added.

Parameters:

key - The key.

value - The value.

get

public java.lang.String get(java.lang.String key)

Returns the value for a key.

Parameters:

key - The key.

Returns:

The value.

getRequiredKeys

protected abstract java.lang.String[] getRequiredKeys()

Returns the required keys.

Returns:

A string array.

isComplete

public boolean isComplete()

Checks if this parameters object contains all necessary parameters.

Returns:

A boolean value.

getMissingKeys

public java.lang.String[] getMissingKeys()

Returns the missing parameters parameters.

Returns:

A string array.

parameterize

public void parameterize(org.apache.avalon.framework.parameters.Parameters parameters)

Parameterizes this wrapper with un-prefixed parameters.

Parameters:

parameters - A parameters object.