com.compomics.software

Class CommandLineUtils

java.lang.Object

com.compomics.software.CommandLineUtils

public class CommandLineUtils
extends java.lang.Object

This class groups some convenience methods for the use of compomics tools in command line.

Author:

Marc Vaudel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SEPARATOR The command line argument separator.

Constructor Summary

Constructors

Constructor and Description
CommandLineUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	concatenate(java.util.ArrayList<java.lang.String> args) Returns the list of arguments as space separated string for the command line.
static java.lang.String	concatenate(java.lang.String[] args) Returns the list of arguments as space separated string for the command line.
static java.lang.String	getCommandLineArgument(java.util.ArrayList<java.io.File> files) Returns the list of file as argument for the command line.
static java.lang.String	getCommandLineArgument(java.io.File file) Returns the file as argument for the command line.
static java.util.ArrayList<java.lang.Double>	getDoubleListFromString(java.lang.String aString, java.lang.String separator) Parses a list of doubles from a command line option.
static java.util.ArrayList<java.io.File>	getFiles(java.lang.String optionInput, java.util.ArrayList<java.lang.String> fileExtentions) Returns a list of files as imported from the command line option.
static java.util.ArrayList<java.lang.Integer>	getIntegerListFromString(java.lang.String aString, java.lang.String separator) Parses a list of integers from a command line option.
static java.lang.String	getQuoteType() Returns the quote type to use.
static java.util.ArrayList<java.lang.String>	splitInput(java.lang.String cliInput) Splits the input of comma separated command line input and returns the results as an arraylist.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

The command line argument separator.

See Also:

Constant Field Values

Constructor Detail

CommandLineUtils

public CommandLineUtils()

Method Detail

getCommandLineArgument

public static java.lang.String getCommandLineArgument(java.util.ArrayList<java.io.File> files)

Returns the list of file as argument for the command line.

Parameters:

files - the files

Returns:

the list of file as string for command line argument

concatenate

public static java.lang.String concatenate(java.util.ArrayList<java.lang.String> args)

Returns the list of arguments as space separated string for the command line.

Parameters:

args - the arguments

Returns:

a comma separated string

concatenate

public static java.lang.String concatenate(java.lang.String[] args)

Returns the list of arguments as space separated string for the command line. Adds quotes where they seem to be needed.

Parameters:

args - the arguments

Returns:

a comma separated string

getQuoteType

public static java.lang.String getQuoteType()

Returns the quote type to use. For example around file paths with spaces.

Returns:

the quote type to use

getCommandLineArgument

public static java.lang.String getCommandLineArgument(java.io.File file)

Returns the file as argument for the command line.

Parameters:

file - the file

Returns:

the list of file as string for command line argument

splitInput

public static java.util.ArrayList<java.lang.String> splitInput(java.lang.String cliInput)

Splits the input of comma separated command line input and returns the results as an arraylist.

Parameters:

cliInput - the CLI input

Returns:

an arraylist containing the results, empty list if empty string

getFiles

public static java.util.ArrayList<java.io.File> getFiles(java.lang.String optionInput,
                                         java.util.ArrayList<java.lang.String> fileExtentions)
                                                  throws java.io.FileNotFoundException

Returns a list of files as imported from the command line option.

Parameters:

optionInput - the command line option

fileExtentions - the file extensions to be considered

Returns:

a list of file candidates

Throws:

java.io.FileNotFoundException - exception thrown whenever a file is not found

getIntegerListFromString

public static java.util.ArrayList<java.lang.Integer> getIntegerListFromString(java.lang.String aString,
                                                              java.lang.String separator)

Parses a list of integers from a command line option.

Parameters:

aString - the command line option

separator - the separator used to separate the string

Returns:

the list if integers

getDoubleListFromString

public static java.util.ArrayList<java.lang.Double> getDoubleListFromString(java.lang.String aString,
                                                            java.lang.String separator)

Parses a list of doubles from a command line option.

Parameters:

aString - the command line option

separator - the separator used to separate the string

Returns:

the list if doubles