org.polarsys.capella.common.helpers.argumentparser

Class ArgumentAnalyzer

java.lang.Object

org.polarsys.capella.common.helpers.argumentparser.ArgumentAnalyzer

Direct Known Subclasses:

BasicArgumentAnalyzer

public class ArgumentAnalyzer
extends java.lang.Object

Utility class in order to analyze arguments

Constructor Summary

Constructors

Constructor and Description
ArgumentAnalyzer(boolean strictMode) Constructor Unknown flags are not treated as error.
ArgumentAnalyzer(boolean strictMode, boolean unknowFlagAsError) Constructor
ArgumentAnalyzer(int numberOfArgument) Constructor for command line without any flag but data passed.

Method Summary

Modifier and Type	Method and Description
void	addFlag(java.lang.String id, Flag flag) Add flag to the argument analyzer
void	addFlag(java.lang.String id, java.lang.String flagName, boolean isMandatory, int nbData) Add flag to the argument analyzer
java.util.List<java.lang.String>	getFlagArgs(java.lang.String flagId)
boolean	isArgHasBeenFound(java.lang.String flagId) Check is a given flag has been found during the parsing.
void	parse(java.lang.String[] arguments) Main job method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentAnalyzer

public ArgumentAnalyzer(int numberOfArgument)

Constructor for command line without any flag but data passed.

Parameters:

numberOfArgument - number of expected data

ArgumentAnalyzer

public ArgumentAnalyzer(boolean strictMode)

Constructor Unknown flags are not treated as error.

Parameters:

strictMode - arguments must be given in a specific order and thus, unknown flags are not allowed

ArgumentAnalyzer

public ArgumentAnalyzer(boolean strictMode,
                        boolean unknowFlagAsError)
                 throws ArgumentAnalyzerException

Constructor

Parameters:

stictMode - arguments must be given in a specific order and thus, unknown flags are not allowed

unknowFlagAsError - should we treat unknown flag as error

Throws:

ArgumentAnalyzerException - when strictMode is set to true and unknowFlagAsError to false (these two notions are not really compatible.)

Method Detail

addFlag

public void addFlag(java.lang.String id,
                    java.lang.String flagName,
                    boolean isMandatory,
                    int nbData)
             throws ArgumentAnalyzerException

Add flag to the argument analyzer

Parameters:

id - id of the flag

flagName - name of the flag

isMandatory - is this flag mandatory

nbData - number of expected data for this argument

Throws:

ArgumentAnalyzerException

addFlag

public void addFlag(java.lang.String id,
                    Flag flag)
             throws ArgumentAnalyzerException

Add flag to the argument analyzer

Parameters:

id - id of the flag

flag - The new argument.

Throws:

ArgumentAnalyzerException - id must be unique

See Also:

Flag}

parse

public void parse(java.lang.String[] arguments)
           throws ArgumentAnalyzerException

Main job method.

Parameters:

arguments - arguments line to analyze.

Throws:

ArgumentAnalyzerException

isArgHasBeenFound

public boolean isArgHasBeenFound(java.lang.String flagId)
                          throws ArgumentAnalyzerException

Check is a given flag has been found during the parsing.

Parameters:

flagId - the target flag Id.

Returns:

Throws:

ArgumentAnalyzerException

getFlagArgs

public java.util.List<java.lang.String> getFlagArgs(java.lang.String flagId)
                                             throws ArgumentAnalyzerException

Parameters:

flagId - the target flag Id

Returns:

a List containing the arguments for the target flag. If no arguments are expected, an empty List is returned. Whether the flag is not mandatory and has not been found, null is returned

Throws:

ArgumentAnalyzerException