de.zib.gndms.logic.action.CommandAction< R > Interface Reference

Configuration actions take a string-string map parameter from some external source and may write results to an optional print writer. More...

Inherits de::zib::gndms::logic::action::Action< R >, and de::zib::gndms::kit::config::ConfigProvider.

List of all members.

Public Member Functions
void	setLocalOptions (final Map< String, String > cfgParams)
	Sets the map containing the local configuration settings,.
String	getLocalOption (final @NotNull String name)
	Returns the setting in the local configuration map for a specific option.
String	localOptionsToString ()
	Returns a String, listing all local option keys and their corresponding values.
Package Functions
Map< String, String >	getLocalOptions ()
	Returns the map containing the local configuration settings.

---

Detailed Description

Configuration actions take a string-string map parameter from some external source and may write results to an optional print writer.

A CommandAction instance has access to local and global options. Whereas local option are the ones set in the configuration for a specific CommandAction object, global options are the local ones plus all options from the set in the parent chain of the instance, being a CommandAction.

The first template parameter is the return type.

Author:

try ste fan pla nti kow zib

Version:

$Id$

User: stepn Date: 14.08.2008 Time: 10:36:15

---

Member Function Documentation

String de.zib.gndms.logic.action.CommandAction< R >.getLocalOption

(

final @NotNull String

name

)

Returns the setting in the local configuration map for a specific option.

Parameters:

name	the name of the option

Returns:

the setting in the local configuration map for a specific option.

Map<String, String> de.zib.gndms.logic.action.CommandAction< R >.getLocalOptions

(

)

[package]

Returns the map containing the local configuration settings.

Returns:

the map containing the configuration settings for this

 CommandAction 

String de.zib.gndms.logic.action.CommandAction< R >.localOptionsToString

(

)

Returns a String, listing all local option keys and their corresponding values.

Note the returned String will is not based only on the local configuration map, but also from all configuration maps in the parent chain. A key must start a letter to be listed.

Returns:

a String, listing all option keys and their corresponding values of all configurations maps, starting from this, in the parent chain.

See also:

de.zib.gndms.kit.config.ParameterTools.asString(java.util.Map, java.util.regex.Pattern)

void de.zib.gndms.logic.action.CommandAction< R >.setLocalOptions

(

final Map< String, String >

cfgParams

)

Sets the map containing the local configuration settings,.

Parameters:

cfgParams

the map containing the local configuration settings.

---

The documentation for this interface was generated from the following file:

• logic/src/de/zib/gndms/logic/action/CommandAction.java