net.sf.mmm.util.cli.base

Class CliValueMap

java.lang.Object

net.sf.mmm.util.cli.base.CliValueMap

public class CliValueMap
extends Object

This class is a container for the values for options and arguments.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private CliState	cliState The CliState.
private CliParserDependencies	dependencies The CliParserDependencies.
private org.slf4j.Logger	logger The Logger to use.
private Map<CliParameterContainer,CliValueContainer>	map

Constructor Summary

Constructors

Constructor and Description
CliValueMap(CliState cliState, CliParserDependencies dependencies, org.slf4j.Logger logger) The constructor.

Method Summary

Modifier and Type	Method and Description
void	assign(Object state) This method applies the parsed CLI values to the given state.
CliValueContainer	get(CliParameterContainer parameterContainer) This method gets the CliValueContainer for the given CliParameterContainer.
CliValueContainer	getOrCreate(CliParameterContainer parameterContainer) This method gets the CliValueContainer for the given CliParameterContainer.

Methods inherited from class java.lang.Object

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

Field Detail

map

private final Map<CliParameterContainer,CliValueContainer> map

dependencies

private final CliParserDependencies dependencies

The CliParserDependencies.

cliState

private final CliState cliState

The CliState.

logger

private final org.slf4j.Logger logger

The Logger to use.

Constructor Detail

CliValueMap

public CliValueMap(CliState cliState,
                   CliParserDependencies dependencies,
                   org.slf4j.Logger logger)

The constructor.

Parameters:

cliState - is the CliState.

dependencies - is the CliParserDependencies.

logger - is the Logger to use.

Method Detail

get

public CliValueContainer get(CliParameterContainer parameterContainer)

This method gets the CliValueContainer for the given CliParameterContainer.

Parameters:

parameterContainer - is the CliParameterContainer that acts as key to the requested CliValueContainerObject.

Returns:

the requested CliValueContainerObject or null if NOT present.

getOrCreate

public CliValueContainer getOrCreate(CliParameterContainer parameterContainer)

This method gets the CliValueContainer for the given CliParameterContainer. In advance to get(CliParameterContainer) this method will create an according CliValueContainerObject if not present and the CliParameterContainer has a setter with a property-type reflecting an array, Collection or Map.

Parameters:

parameterContainer - is the CliParameterContainer that acts as key to the requested CliValueContainerObject.

Returns:

the requested CliValueContainerObject or null if NOT present and NOT created.

assign

public void assign(Object state)

This method applies the parsed CLI values to the given state.

Parameters:

state - is the state-object where to apply the values of this CliValueMap.