org.ow2.proactive.utils

Class Tools

java.lang.Object

org.ow2.proactive.utils.Tools

@PublicAPI
public class Tools
extends Object

Provides some methods used by the scheduler or the GUI to display some tips properly.

Since:

ProActive Scheduling 0.9

Constructor Summary

Constructors

Constructor and Description
Tools()

Method Summary

Modifier and Type	Method and Description
static String[]	dataSpaceConfigPropertyToUrls(String property) Parses the given dataspace configuration property to an array of strings The parsing handles double quotes and space separators
static long	formatDate(String pattern) Format the given string and return a long that correspond to the time represented by the given string.
static String	formatNChar(int toFormat, int nbChar, char replacement) Format the given integer 'toFormat' to a String containing 'nbChar' characters
static String	getElapsedTime(long time)
static String	getFormattedDate(long time) Return the given date as a formatted string.
static String	getFormattedDuration(long start, long end) Format 2 long times into a single duration as a String.
static String	getHostURL(String url) Normalize the given URL into an URL that only contains protocol://host:port/
static String	getStringAsArray(ObjectArrayFormatter oaf) Get the columned string according to the given ObjectArrayFormatter descriptor.
static void	logAvailableScriptEngines(org.apache.log4j.Logger logger) Log available script engines at INFO level.
static String[]	parseCommandLine(String cmdLine) Parse a command line in order to split it into a string array.
static long	parsePeriod(String periodString) Translates time period string into milliseconds.
static String	shellExtension() Return the extension of shell script depending the current OS

Methods inherited from class java.lang.Object

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

Constructor Detail

Tools

public Tools()

Method Detail

formatNChar

public static String formatNChar(int toFormat,
                                 int nbChar,
                                 char replacement)

Format the given integer 'toFormat' to a String containing 'nbChar' characters

Parameters:

toFormat - the number to format

nbChar - the number of characters of the formatted result string

Returns:

the given integer formatted as a 'nbChar' length String.

getFormattedDuration

public static String getFormattedDuration(long start,
                                          long end)

Format 2 long times into a single duration as a String. The string will contains the duration in Days, hours, minutes, seconds, and millis.

Parameters:

start - the first date (time)

end - the second date (time)

Returns:

the duration as a formatted string.

getFormattedDate

public static String getFormattedDate(long time)

Return the given date as a formatted string.

Parameters:

time - the date as a long.

Returns:

the given date as a formatted string.

getElapsedTime

public static String getElapsedTime(long time)

formatDate

public static long formatDate(String pattern)

Format the given string and return a long that correspond to the time represented by the given string. If the string is not proper, 0 will be returned.

Parameters:

pattern - a time pattern that must be in [[HH:]MM:]SS where HH, MM, and SS are numbers

Returns:

a long corresponding to the given time.

getHostURL

public static String getHostURL(String url)

Normalize the given URL into an URL that only contains protocol://host:port/

Parameters:

url - the url to transform

Returns:

an URL that only contains protocol://host:port/

parseCommandLine

public static String[] parseCommandLine(String cmdLine)

Parse a command line in order to split it into a string array. This method provides the parsing as followed :
- It is split according to the 'white space' character.
- It is possible to escape white space character using the '%' character.
- To write this '%' special char, just escape it ( '%%' ).
For example, the string "cmd arg1 arg% 2 arg%%% 3 arg4%% 5" will return the following string array :
[cmd,arg1,arg 2,arg% 3,arg4%,5]

This method can be mostlikely used for Runtime.exec(String[]) method.

Parameters:

cmdLine - The command line to parse.

Returns:

a string array that represents the parsed command line.

shellExtension

public static String shellExtension()

Return the extension of shell script depending the current OS

Returns:

the extension of shell script depending the current OS

dataSpaceConfigPropertyToUrls

public static String[] dataSpaceConfigPropertyToUrls(String property)

Parses the given dataspace configuration property to an array of strings The parsing handles double quotes and space separators

Parameters:

property - dataspace configuration property

Returns:

an array of string urls

getStringAsArray

public static String getStringAsArray(ObjectArrayFormatter oaf)

Get the columned string according to the given ObjectArrayFormatter descriptor.

Parameters:

oaf - the ObjectArrayFormatter describing how to print the array.

Returns:

the columned string according the given descriptor

parsePeriod

public static long parsePeriod(String periodString)

Translates time period string into milliseconds. Period string should contain symbol indication length of the period:

• 's' - seconds
• 'm' - minutes
• 'h' - hours
• 'd' - days

Examples of valid time period expressions:

• '1m' - one minute
• '1d 10h' - one day and ten hours

logAvailableScriptEngines

public static void logAvailableScriptEngines(org.apache.log4j.Logger logger)

Log available script engines at INFO level.

Parameters:

logger - the logger instance used to log available script engines.