• Home
• com.atlassian.clover
• clover
• 4.1.2
• source code
• CIOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.atlassian.clover.api.ci.CIOptions Maven / Gradle / Ivy

package com.atlassian.clover.api.ci;

import java.io.File;
import java.io.Serializable;

public class CIOptions implements Serializable {

    private final boolean optimize;
    private final boolean html;
    private final boolean json;
    private final boolean pdf;
    private final boolean xml;

    private final boolean historical;
    private final String licenseCert;
    private final File license;
    private final File historyDir;
    private final boolean fullClean;
    private final boolean putValuesInQuotes;

    private CIOptions(Builder builder) {
        this.optimize = builder.optimize;
        this.html = builder.html;
        this.json = builder.json;
        this.historical = builder.historical;
        this.licenseCert = builder.licenseCert;
        this.license = builder.license;
        this.historyDir = builder.historyDir;
        this.fullClean = builder.fullClean;
        this.pdf = builder.pdf;
        this.xml = builder.xml;
        this.putValuesInQuotes = builder.putValuesInQuotes;
    }

    public boolean isOptimize() {
        return optimize;
    }

    public boolean isHtml() {
        return html;
    }

    public boolean isJson() {
        return json;
    }

    public String getLicenseCert() {
        return licenseCert;
    }

    public File getLicense() {
        return license;
    }

    public File getHistoryDir() {
        return historyDir;
    }

    public boolean isHistorical() {
        return historical;
    }

    public boolean isFullClean() {
        return fullClean;
    }

    public boolean isPdf() {
        return pdf;
    }

    public boolean isXml() {
        return xml;
    }

    public boolean isPutValuesInQuotes() {
        return putValuesInQuotes;
    }

    /**
     * This class is used to configure one of the {@link com.atlassian.clover.api.ci.Integrator} classes.
     * Obtain a set of CIOptions using the static factory method: CIOptions.newDefaults().
     */
    public static class Builder implements Serializable {

        private boolean optimize = false;
        private boolean html = true;
        private boolean json = false;
        private boolean pdf = false;
        private boolean xml = true;
        private boolean historical = false;
        private String licenseCert = null;
        private File license = null;
        private File historyDir = null;
        private boolean fullClean = false;
        private boolean putValuesInQuotes = false;

        /**
         * Creates a brand new CIOptionsBuilder with default values.
         */
        public Builder() {

        }

        /**
         * Whether or not to optimize tests.
         *
         * @param optimize true if tests should be optimized using Clover's test optimization
         * @return these options, but with optimization turned on.
         */
        public Builder optimize(boolean optimize) {
            this.optimize = optimize;
            return this;
        }

        public Builder html(boolean html) {
            this.html = html;
            return this;
        }

        public Builder json(boolean json) {
            this.json = json;
            return this;
        }

        public Builder pdf(boolean pdf) {
            this.pdf = pdf;
            return this;
        }

        public Builder xml(boolean xml) {
            this.xml = xml;
            return this;
        }

        public Builder historical(boolean historical) {
            this.historical = historical;
            return this;
        }

        /**
         * Use the given Clover license String for the build.
         *
         * @param licenseCert the license cert (including newline chars) to use
         * @return Builder this
         */
        public Builder licenseCert(String licenseCert) {
            this.licenseCert = licenseCert;
            return this;
        }

        /**
         * Use the given Clover license Path for the build.
         *
         * @param license a file representing the clover license
         * @return Builder this
         */
        public Builder license(File license) {
            this.license = license;
            return this;
        }


        /**
         * Use the given history directory to store Clover artifacts which are needed by Clover between builds.
         * For example: Clover history points used to generate a Clover Historical Report,
         * or the clover.snapshot file needed for Test Optimization.
         *
         * @param historyDir a directory to store Clover data between builds.
         * @return Builder this
         */
        public Builder historyDir(File historyDir) {
            this.historyDir = historyDir;
            return this;
        }

        /**
         * @param fullClean true if all previous clover data (excluding the historydir) should be removed before running
         *                  the build.
         * @return Builder this
         */
        public Builder fullClean(boolean fullClean) {
            this.fullClean = fullClean;
            return this;
        }

        /**
         * 
Applicable for AntIntegrator only.
         *
         * 
If set to true then some of Clover's properties will be put in double quotes. This is to
         * solve a problem with properties containing whitespace characters. Ant prior to version 1.9.7 passes
         * arguments to the JVM process incorrectly on non-Windows operating systems - for example "[-Da=b c][-De=f]"
         * may be passed as "[-Da=b] [c] [-De=f]".
         *
         * 
Set this value to true if the following conditions are met:

         *  - you have Ant version older than 1.9.7

         *  - you are not building on Windows platform
         *
         * 
Double quotes will not be added on Windows platform, even if the property is set to true.
         *
         * 
Ant since version 1.9.7 passes arguments with spaces correctly therefore do not set this parameter to
         * true, otherwise you'll end up with values containing double quotes.
         *
         * @param inQuotes true - put values in double quotes, false - put values as is
         * @return Builder this
         */
        public Builder putValuesInQuotes(boolean inQuotes) {
            this.putValuesInQuotes = inQuotes;
            return this;
        }

        public CIOptions build() {
            return new CIOptions(this);
        }

        @Override
        public String toString() {
            return "Builder{" +
                    "optimize=" + optimize +
                    ", html=" + html +
                    ", json=" + json +
                    ", pdf=" + pdf +
                    ", xml=" + xml +
                    ", historical=" + historical +
                    ", licenseCert='" + licenseCert + "'" +
                    ", license='" + license + "'" +
                    ", historyDir='" + historyDir + "'" +
                    ", fullClean=" + fullClean +
                    ", putValuesInQuotes=" + putValuesInQuotes +
                    '}';
        }
    }


}