com.manoelcampos.javadoc.coverage.Utils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javadoc-coverage Show documentation
Doclet to generate coverage reports of JavaDoc documentation.
There is a newer version: 1.1.1
/*
 * Copyright 2017-2017 Manoel Campos da Silva Filho
 *
 * Licensed under the General Public License Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.gnu.org/licenses/gpl-3.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.manoelcampos.javadoc.coverage;

import java.io.File;
import java.util.Arrays;
import java.util.stream.DoubleStream;

/**
 * A class providing some utility methods.
 *
 * @author Manoel Campos da Silva Filho
 * @since 1.0.0
 */
public final class Utils {
    /**
     * A private constructor to avoid class instantiation.
     */
    private Utils() {}

    public static boolean isNotStringEmpty(final String str) {
        return !isStringEmpty(str);
    }

    public static boolean isStringEmpty(final String str) {
        return str == null || str.trim().isEmpty();
    }

    /**
     * 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.
     *
     * @param path the path to include a trailing slash
     * @return the path with a trailing slash if there wasn't one and the path is not empty,
     * the original path otherwise
     */
    public static String includeTrailingDirSeparator(final String path) {
        if (path.trim().isEmpty()) {
            return path;
        }

        if (path.charAt(path.length() - 1) != File.separatorChar) {
            return path + File.separator;
        }

        return path;
    }

    /**
     * Computes the percentage that a partial value corresponds to a given total.
     *
     * @param partialValue the partial value to compute the percentage related to the total value
     * @param totalValue the total the partial value corresponds to
     * @return the percentage (in scale from 0 to 100) the partial value represents from the total
     */
    public static double computePercentage(final double partialValue, final double totalValue){
        if(totalValue == 0){
            return 0;
        }

        return (partialValue/totalValue) * 100.0;

    }

    /**
     * Computes the mean value from a list of values.
     *
     * @param values the values to compute the mean from
     * @return the computed mean
     */
    public static double mean(final double... values){
        if(values == null){
            return 0;
        }

        return average(Arrays.stream(values));
    }

    /**
     * Computes the mean value from a Stream of values.
     *
     * @param stream the Stream of values to compute the mean from
     * @return the computed mean
     */
    public static double average(final DoubleStream stream) {
        return stream.average().orElse(0);
    }

    /**
     * Converts a boolean to its corresponding int
     *
     * @param bool the boolean value to convert
     * @return 1 whether the bool is equal to true; 0 otherwise
     */
    public static int boolToInt(final boolean bool) {
        return bool ? 1 : 0;
    }

    /**
     * Gets the extension of a file.
     *
     * @param fileName the name of the file
     * @return the file extension, including the dot, or an empty string
     * if there isn't a extension
     */
    public static String getFileExtension(final String fileName) {
        final int i = fileName.lastIndexOf('.');
        return i > 0 ? fileName.substring(i) : "";
    }
}