com.manoelcampos.javadoc.coverage

Class Utils

java.lang.Object

com.manoelcampos.javadoc.coverage.Utils

public final class Utils
extends Object

A class providing some utility methods.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Method Summary

Modifier and Type	Method and Description
static double	average(DoubleStream stream) Computes the mean value from a Stream of values.
static int	boolToInt(boolean bool) Converts a boolean to its corresponding int
static double	computePercentage(double partialValue, double totalValue) Computes the percentage that a partial value corresponds to a given total.
static String	getFileExtension(String fileName) Gets the extension of a file.
static String	includeTrailingDirSeparator(String path) Adds a trailing slash at the end of a path if it doesn't have one yet.
static boolean	isNotStringEmpty(String str)
static boolean	isStringEmpty(String str)
static double	mean(double... values) Computes the mean value from a list of values.

Methods inherited from class java.lang.Object

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

Method Detail

isNotStringEmpty

public static boolean isNotStringEmpty(String str)

isStringEmpty

public static boolean isStringEmpty(String str)

includeTrailingDirSeparator

public static String includeTrailingDirSeparator(String path)

Adds a trailing slash at the end of a path if it doesn't have one yet. The trailing slash type is system-dependent and will be accordingly selected.

Parameters:

path - the path to include a trailing slash

Returns:

the path with a trailing slash if there wasn't one and the path is not empty, the original path otherwise

computePercentage

public static double computePercentage(double partialValue,
                                       double totalValue)

Computes the percentage that a partial value corresponds to a given total.

Parameters:

partialValue - the partial value to compute the percentage related to the total value

totalValue - the total the partial value corresponds to

Returns:

the percentage (in scale from 0 to 100) the partial value represents from the total

mean

public static double mean(double... values)

Computes the mean value from a list of values.

Parameters:

values - the values to compute the mean from

Returns:

the computed mean

average

public static double average(DoubleStream stream)

Computes the mean value from a Stream of values.

Parameters:

stream - the Stream of values to compute the mean from

Returns:

the computed mean

boolToInt

public static int boolToInt(boolean bool)

Converts a boolean to its corresponding int

Parameters:

bool - the boolean value to convert

Returns:

1 whether the bool is equal to true; 0 otherwise

getFileExtension

public static String getFileExtension(String fileName)

Gets the extension of a file.

Parameters:

fileName - the name of the file

Returns:

the file extension, including the dot, or an empty string if there isn't a extension