AbstractCommandLineInterface (hpc utils 0.0.5 API)

java.lang.Object
- it.cnr.isti.hpc.cli.AbstractCommandLineInterface

```
public abstract class AbstractCommandLineInterface
extends Object
```
AbtractCommandLineInterface provides facilities to create command line interface classes (CLI). A class extending this class, accepts by default an input and an output file, i.e., can be called using the syntax:
```
 
 java YourClassCLI -input fileinput  -output fileoutput
 
 
```
where fileinput and fileoutput represent two filepaths. Please note that fileinput must point to an existing input file while if fileoutput does not exist the file will create (otherwise will be overwritten).

It is possible to modify the parameters accepted giving the list in the constructor. The class will take care to valide them and to fail if a parameter is missing. You can also define an usage message that will be printed everytime the cli is called with wrong parameters.

Please, add the suffix CLI to the classes that extend this class, e.g., MyclassCLI.java.
Author:

Diego Ceccarelli, diego.ceccarelli@isti.cnr.it created on 21/set/2011

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`INPUT` Default name for the input file
`static String`	`OUTPUT` Default name for the output file
`protected Map<String,String>`	`params`
`protected String`	`usage` Default usage string, overwrite it to change the message

Constructor Summary

Constructors
Constructor and Description
`AbstractCommandLineInterface()` Do not use this costructor
`AbstractCommandLineInterface(String[] args)` Default costructor
`AbstractCommandLineInterface(String[] args, String[] parameters)`
`AbstractCommandLineInterface(String[] args, String[] parameters, String usage)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`closeInput()` Closes the input file, terminates the cli if an error occurs.
`protected void`	`closeInputAndOuput()` Closes both input and output file, terminates the cli if an error occurs.
`protected void`	`closeOutput()` Closes the output file, terminates the cli if an error occurs.
`protected double`	`getDoubleParam(String param)` Returns the double value of a particular parameter
`protected String`	`getInput()` Returns the input filename.
`protected int`	`getIntParam(String param)` Returns the int value of a particular parameter
`protected String`	`getOutput()` Returns the output filename.
`protected String`	`getParam(String param)` Returns the value of a particular parameter
`String`	`getUsage()` Returns the usage message.
`protected void`	`openInput()` Opens the file given in input, if the file ends with .gz, it uses a compressed reader.
`protected void`	`openInputAndOutput()` Opens both input and output, terminates the cli if an error occurs.
`protected void`	`openOutput()` Open the file given in output, if the file ends with .gz, it uses a compressed writer.
`protected String`	`readLineFromInput()` Reads the next line on the inputfile, if the file ends returns null.
`void`	`setUsage(String usage)` Sets the usage message.
`protected void`	`writeInOutput(String str)` Writes text in the output file.
`protected void`	`writeLineInOutput(String line)` Writes a line in the output file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INPUT
```
public static final String INPUT
```
    Default name for the input file
    
    See Also:
    Constant Field Values
  - OUTPUT
```
public static final String OUTPUT
```
    Default name for the output file
    
    See Also:
    Constant Field Values
  - params
```
protected Map<String,String> params
```
  - usage
```
protected String usage
```
    Default usage string, overwrite it to change the message
- Constructor Detail
  - AbstractCommandLineInterface
```
public AbstractCommandLineInterface()
```
    Do not use this costructor
  - AbstractCommandLineInterface
```
public AbstractCommandLineInterface(String[] args)
```
    Default costructor
    
    Parameters:
    args - the main args
  - AbstractCommandLineInterface
```
public AbstractCommandLineInterface(String[] args,
                            String[] parameters)
```
    Parameters:
    args - the main args
    parameters - the parameters accepted by this cli, if different by the default.
  - AbstractCommandLineInterface
```
public AbstractCommandLineInterface(String[] args,
                            String[] parameters,
                            String usage)
```
    Parameters:
    args - the main args
    parameters - the parameters accepted by this cli, if different by the default.
    usage - an usage string if different by the default.
- Method Detail
  - getInput
```
protected String getInput()
```
    Returns the input filename.
    
    Returns:
    the input filename
  - getOutput
```
protected String getOutput()
```
    Returns the output filename.
    
    Returns:
    the output filename
  - getParam
```
protected String getParam(String param)
```
    Returns the value of a particular parameter
    
    Parameters:
    param - the parameter
    
    Returns:
    the value associated with the parameter
  - getIntParam
```
protected int getIntParam(String param)
```
    Returns the int value of a particular parameter
    
    Parameters:
    param - the parameter
    
    Returns:
    the value associated with the parameter
  - getDoubleParam
```
protected double getDoubleParam(String param)
```
    Returns the double value of a particular parameter
    
    Parameters:
    param - the parameter
    
    Returns:
    the value associated with the parameter
  - openInput
```
protected void openInput()
```
    Opens the file given in input, if the file ends with .gz, it uses a compressed reader.
  - openOutput
```
protected void openOutput()
```
    Open the file given in output, if the file ends with .gz, it uses a compressed writer.
  - readLineFromInput
```
protected String readLineFromInput()
```
    Reads the next line on the inputfile, if the file ends returns null. Terminates the cli if an error occurs.
  - writeLineInOutput
```
protected void writeLineInOutput(String line)
```
    Writes a line in the output file. Terminates the cli if an error occurs.
  - writeInOutput
```
protected void writeInOutput(String str)
```
    Writes text in the output file. Terminates the cli if an error occurs.
  - openInputAndOutput
```
protected void openInputAndOutput()
```
    Opens both input and output, terminates the cli if an error occurs.
  - closeInput
```
protected void closeInput()
```
    Closes the input file, terminates the cli if an error occurs.
  - closeOutput
```
protected void closeOutput()
```
    Closes the output file, terminates the cli if an error occurs.
  - closeInputAndOuput
```
protected void closeInputAndOuput()
```
    Closes both input and output file, terminates the cli if an error occurs.
  - getUsage
```
public String getUsage()
```
    Returns the usage message.
    
    Returns:
    the usage message
  - setUsage
```
public void setUsage(String usage)
```
    Sets the usage message.
    
    Parameters:
    usage - the usage message

Class AbstractCommandLineInterface

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INPUT

OUTPUT

params

usage

Constructor Detail

AbstractCommandLineInterface

AbstractCommandLineInterface

AbstractCommandLineInterface

AbstractCommandLineInterface

Method Detail

getInput

getOutput

getParam

getIntParam

getDoubleParam

openInput

openOutput

readLineFromInput

writeLineInOutput

writeInOutput

openInputAndOutput

closeInput

closeOutput

closeInputAndOuput

getUsage

setUsage