org.eodisp.util.configuration
Interface CommandlineMapper

All Known Implementing Classes:

BasicCommandlineMapper, ManualCommandlineMapper

public interface CommandlineMapper

Interface of the command line wrapper. Maps configuration entries (Configuration.Entry) to command line parameters.

Version:

$Id: CommandlineMapper.java 3018 2006-08-11 22:23:35Z ibirrer $

Author:

ibirrer

Field Summary

static CommandlineMapper	BASIC_COMMAND_LINE_MAPPER Returns a basic command line mapper that maps configuration entries of type boolean to Switch and others to FlaggedOption instances.
static CommandlineMapper	NULL_COMMAND_LINE_MAPPER

Method Summary

com.martiansoftware.jsap.Parameter

mapEntry(Configuration.Entry entry) Returns the JSAP parameter (command line option) that is mapped to the given entry.

Field Detail

NULL_COMMAND_LINE_MAPPER

static final CommandlineMapper NULL_COMMAND_LINE_MAPPER

BASIC_COMMAND_LINE_MAPPER

static final CommandlineMapper BASIC_COMMAND_LINE_MAPPER

Returns a basic command line mapper that maps configuration entries of type boolean to Switch and others to FlaggedOption instances. The id of the JSAP parameter is set to the following string: ConfigurationId.ConfigurationEntryId. The long flag is the key of the configuration entry (Configuration.Entry.getKey()) and the help is set from the configuration's description (Configuration.Entry.getDescription()).

Method Detail

mapEntry

com.martiansoftware.jsap.Parameter mapEntry(Configuration.Entry entry)

Returns the JSAP parameter (command line option) that is mapped to the given entry. A return value of null means that no command line option shall be created for the given entry.

Parameters:

entry - the entry that shall be mapped to a parameter

Returns:

the parameter mapped to the given configuration entry or null if the given configuration entry shall not be mapped to a command line option.