com.compuware.jenkins.common.utils

Class ArgumentUtils

java.lang.Object

com.compuware.jenkins.common.utils.ArgumentUtils

public class ArgumentUtils
extends Object

Utility class containing helper methods for handling arguments.

Method Summary

Modifier and Type	Method and Description
static Properties	convertStringToProperties(String propertiesString) Converts the given properties String to a Properties object.
static String	escapeCommaDelimitedPathsForScript(String input) Returns an escaped version of the given comma-delmited paths input String for a Batch or Shell script.
static String	escapeForScript(String input) Returns an escaped version of the given input String for a Batch or Shell script.
static String	prefixWithDash(String input) Prefixes the given input String with a dash (-).
static String	resolvePath(String folder, String workspacePath) Resolves a folder name to an absolute path.
static String	wrapInDoubleQuotes(String input) Wraps the given input String in double quotes.

Methods inherited from class java.lang.Object

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

Method Detail

escapeForScript

public static String escapeForScript(String input)

Returns an escaped version of the given input String for a Batch or Shell script.

For comma-delimited path Strings, use escapeCommaDelimitedPathsForScript(String) instead as this method does not account for the possibility of the user surrounding each path with double quotes.

If the input String is null/empty or does not require escaping, it is returned unchanged.

Parameters:

input - the String to escape

Returns:

the escaped String

escapeCommaDelimitedPathsForScript

public static String escapeCommaDelimitedPathsForScript(String input)

Returns an escaped version of the given comma-delmited paths input String for a Batch or Shell script.

This method accounts for the possibility of the user surrounding each path in the input String with double quotes. For all other Strings, use escapeForScript(String) instead.

If the input String is null/empty or does not require escaping, it is returned unchanged.

Parameters:

input - the comma-delimited paths String to escape

Returns:

the escaped String

wrapInDoubleQuotes

public static String wrapInDoubleQuotes(String input)

Wraps the given input String in double quotes.

If the input String is null/empty or is already wrapped in double quotes, it is returned unchanged.

Parameters:

input - the String to wrap in double quotes

Returns:

the double-quoted String

prefixWithDash

public static String prefixWithDash(String input)

Prefixes the given input String with a dash (-).

If the input String is already prefixed with a dash, it is returned unchanged.

Parameters:

input - the String to prefix

Returns:

the prefixed String

convertStringToProperties

public static Properties convertStringToProperties(String propertiesString)
                                            throws IOException

Converts the given properties String to a Properties object.

If the given properties String is null/empty, an empty Properties object is returned.

Parameters:

propertiesString - the String to convert

Returns:

the Properties object

Throws:

IOException - if an error occurred during conversion

See Also:

Properties.load(Reader)

resolvePath

public static String resolvePath(String folder,
                                 String workspacePath)

Resolves a folder name to an absolute path.

Parameters:

folder - the name of a folder or an absolute path

workspacePath - absolute path of the project workspace

Returns:

absolute path of of a folder