JacocoLimit.java

/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.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 org.gradle.testing.jacoco.tasks.rules;

import org.gradle.api.Incubating;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;

import java.io.Serializable;
import java.math.BigDecimal;

/**
 * Defines a Jacoco rule limit.
 *
 * @since 3.4
 */
@Incubating
public interface JacocoLimit extends Serializable {

    /**
     * The counter that applies to the limit as defined by
     * <a href="http://www.eclemma.org/jacoco/trunk/doc/api/org/jacoco/core/analysis/ICoverageNode.CounterEntity.html">org.jacoco.core.analysis.ICoverageNode.CounterEntity</a>.
     * Valid values are INSTRUCTION, LINE, BRANCH, COMPLEXITY, METHOD and CLASS. Defaults to INSTRUCTION.
     */
    @Input
    String getCounter();

    /**
     * Sets the counter that applies to the limit.
     *
     * @param counter Counter
     */
    void setCounter(String counter);

    /**
     * The value that applies to the limit as defined by
     * <a href="http://www.eclemma.org/jacoco/trunk/doc/api/org/jacoco/core/analysis/ICounter.CounterValue.html">org.jacoco.core.analysis.ICounter.CounterValue</a>.
     * Valid values are TOTALCOUNT, MISSEDCOUNT, COVEREDCOUNT, MISSEDRATIO and COVEREDRATIO. Defaults to COVEREDRATIO.
     */
    @Input
    String getValue();

    /**
     * Sets the value that applies to the limit.
     *
     * @param value Value
     */
    void setValue(String value);

    /**
     * Gets the minimum expected value for limit. Default to null.
     */
    @Input
    @Optional
    BigDecimal getMinimum();

    /**
     * Sets the minimum expected value for limit.
     *
     * @param minimum Minimum
     */
    void setMinimum(BigDecimal minimum);

    /**
     * Gets the maximum expected value for limit. Default to null.
     */
    @Input
    @Optional
    BigDecimal getMaximum();

    /**
     * Sets the maximum expected value for limit.
     *
     * @param maximum Maximum
     */
    void setMaximum(BigDecimal maximum);
}