hebdobot/src/org/april/hebdobot/util/BuildInformation.java

/**
 * Copyright (C) 2016-2017 Christian Pierre MOMON <cmomon@april.org>
 *
 * This file is part of (April) Hebdobot.
 *
 * Hebdobot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Hebdobot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Hebdobot.  If not, see <http://www.gnu.org/licenses/>
 */
package org.april.hebdobot.util;

import java.io.IOException;
import java.net.URL;
import java.util.Properties;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The Class BuildInformation.
 */
public class BuildInformation
{
    private static final Logger logger = LoggerFactory.getLogger(BuildInformation.class);

    private static String BUILD_INFORMATION_FILE = "/org/april/hebdobot/build_information.properties";

    private String productName;
    private String majorRevision;
    private String minorRevision;
    private String buildNumber;
    private String snapshotStamp;
    private String buildDate;
    private String generator;
    private String author;

    /**
     * Instantiates a new builds the information.
     */
    public BuildInformation()
    {
        Properties build = new Properties();

        try
        {
            //
            URL buildInformationFile = BuildInformation.class.getResource(BUILD_INFORMATION_FILE);

            if (buildInformationFile != null)
            {
                build.load(BuildInformation.class.getResource(BUILD_INFORMATION_FILE).openStream());
            }

            //
            this.productName = build.getProperty("product.name", "DevInProgress");
            this.majorRevision = build.getProperty("product.revision.major", "d");
            this.minorRevision = build.getProperty("product.revision.minor", "e");
            this.buildNumber = build.getProperty("product.revision.build", "v");
            this.snapshotStamp = build.getProperty("product.revision.snapshot", "-s");
            this.buildDate = build.getProperty("product.revision.date", "today");
            this.generator = build.getProperty("product.revision.generator", "n/a");
            this.author = build.getProperty("product.revision.author", "n/a");

        }
        catch (IOException exception)
        {
            //
            logger.error("Error loading the build.properties file: " + exception.getMessage());
            logger.error(ExceptionUtils.getStackTrace(exception));

            //
            this.productName = "n/a";
            this.majorRevision = "n/a";
            this.minorRevision = "n/a";
            this.buildNumber = "n/a";
            this.snapshotStamp = "n/a";
            this.buildDate = "n/a";
            this.generator = "n/a";
            this.author = "n/a";
        }
    }

    public String author()
    {
        return this.author;
    }

    public String buildDate()
    {
        return this.buildDate;
    }

    public String buildNumber()
    {
        return this.buildNumber;
    }

    public String generator()
    {
        return this.generator;
    }

    public String majorRevision()
    {
        return this.majorRevision;
    }

    public String minorRevision()
    {
        return this.minorRevision;
    }

    public String productName()
    {
        return this.productName;
    }

    public String snapshotStamp()
    {
        return this.snapshotStamp;
    }

    /**
     * To string.
     *
     * @return the string
     */
    @Override
    public String toString()
    {
        String result;

        result = String.format("%s %s.%s.%s%s built on %s by %s", StringUtils.capitalize(this.productName), this.majorRevision, this.minorRevision,
                this.buildNumber, this.snapshotStamp, this.buildDate, this.author);

        //
        return result;
    }

    /**
     * Version.
     *
     * @return the string
     */
    public String version()
    {
        String result;

        result = String.format("%s.%s.%s%s", this.majorRevision, this.minorRevision, this.buildNumber, this.snapshotStamp);

        //
        return result;
    }

    /**
     * Checks if is defined.
     *
     * @return true, if is defined
     */
    public static boolean isDefined()
    {
        boolean result;

        if (BuildInformation.class.getResource(BUILD_INFORMATION_FILE) == null)
        {
            result = false;
        }
        else
        {
            result = true;
        }

        //
        return result;
    }
}