org.polarsys.capella.common.helpers.argumentparser

Class BasicArgumentAnalyzer

java.lang.Object

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

org.polarsys.capella.common.helpers.argumentparser.BasicArgumentAnalyzer

public class BasicArgumentAnalyzer
extends ArgumentAnalyzer

Specialization of the ArgumentAnalyzer class for the case where no flags are defined (but some arguments.)

Constructor Summary

Constructors

Constructor and Description
BasicArgumentAnalyzer(int numberOfArgument) Constructor

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>	getArgs()
java.util.List<java.lang.String>	getFlagArgs(java.lang.String id)
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

BasicArgumentAnalyzer

public BasicArgumentAnalyzer(int numberOfArgument)

Constructor

Parameters:

numberOfArgument -

Method Detail

parse

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

Description copied from class: ArgumentAnalyzer

Main job method.

Overrides:

parse in class ArgumentAnalyzer

Parameters:

arguments - arguments line to analyze.

Throws:

ArgumentAnalyzerException

See Also:

ArgumentAnalyzer.parse(java.lang.String[])

getArgs

public java.util.List<java.lang.String> getArgs()

addFlag

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

Description copied from class: ArgumentAnalyzer

Add flag to the argument analyzer

Overrides:

addFlag in class ArgumentAnalyzer

Parameters:

id - id of the flag

flag - The new argument.

Throws:

ArgumentAnalyzerException - id must be unique

See Also:

org.polarsys.capella.common.helpers.argumentparser.ArgumentAnalyzer#addFlag(java.lang.String, org.polarsys.capella.common.helpers.argumentparser.ArgumentAnalyzer.Flag)

addFlag

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

Description copied from class: ArgumentAnalyzer

Add flag to the argument analyzer

Overrides:

addFlag in class ArgumentAnalyzer

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

See Also:

ArgumentAnalyzer.addFlag(java.lang.String, java.lang.String, boolean, int)

getFlagArgs

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

Overrides:

getFlagArgs in class ArgumentAnalyzer

Parameters:

id - 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

isArgHasBeenFound

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

Description copied from class: ArgumentAnalyzer

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

Overrides:

isArgHasBeenFound in class ArgumentAnalyzer

Parameters:

flagId - the target flag Id.

Returns:

Throws:

ArgumentAnalyzerException