org.ow2.proactive.scripting.helper.progress

Class ProgressFile

java.lang.Object

org.ow2.proactive.scripting.helper.progress.ProgressFile

public final class ProgressFile
extends Object

Utility methods that can be invoked from scripts to ease reading and writing of progress values from or to a file.

Constructor Summary

Constructors

Constructor and Description
ProgressFile()

Method Summary

Modifier and Type	Method and Description
static int	getProgress(Path progressFile) Returns the progress value read from the specified progressFile as an int.
static int	getProgress(String progressFilePath) Returns the progress value read from the specified progressFilePath as an int.
static boolean	isValidProgressValue(int value) Returns a boolean that indicates whether the specified value is a valid progress value.
static boolean	setProgress(Path progressFile, int value) Write the specified value to the given progressFilePath if the value is between 0 and 100 included.
static boolean	setProgress(Path progressFile, String value) Write the specified value to the given progressFilePath.
static boolean	setProgress(String progressFilePath, int value) Write the specified value to the given progressFilePath if the value is between 0 and 100 included.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressFile

public ProgressFile()

Method Detail

getProgress

public static int getProgress(String progressFilePath)

Returns the progress value read from the specified progressFilePath as an int.

Parameters:

progressFilePath - the absolute path to the progress file to read from.

Returns:

the progress value read or -1 in case of error.

getProgress

public static int getProgress(Path progressFile)

Returns the progress value read from the specified progressFile as an int.

Parameters:

progressFile - the progress file to read from.

Returns:

the progress value read, 0 if the specified progressFile does not exist or is empty, -1 in case of error.

isValidProgressValue

public static boolean isValidProgressValue(int value)

Returns a boolean that indicates whether the specified value is a valid progress value.

Parameters:

value - the progress value to check.

Returns:

true if the specified value is between 0 and 100 included, false otherwise.

setProgress

public static boolean setProgress(String progressFilePath,
                                  int value)

Write the specified value to the given progressFilePath if the value is between 0 and 100 included. Otherwise, nothing is performed.

Parameters:

progressFilePath - the absolute path to the file to write the progress value in.

value - the progress value, expected to be between 0 and 100 included.

Returns:

false if the value is out of range or an IO exception occurred, true otherwise.

setProgress

public static boolean setProgress(Path progressFile,
                                  int value)

Write the specified value to the given progressFilePath if the value is between 0 and 100 included. Otherwise, nothing is performed.

Parameters:

progressFile - the path to the file to write the progress value in.

value - the progress value, expected to be between 0 and 100 included.

Returns:

false if the value is out of range or an IO exception occurred, true otherwise.

setProgress

public static boolean setProgress(Path progressFile,
                                  String value)

Write the specified value to the given progressFilePath. No check is performed regarding the type of the value. This method is mainly here for test purposes.

Parameters:

progressFile - the path to the file to write the progress value in.

value - the progress value

Returns:

false if an IO exception occurred, true otherwise.