org.sonar.server.computation.formula.SumFormula.java Source code

Introduction

Here is the source code for org.sonar.server.computation.formula.SumFormula.java

Source

/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.computation.formula;

import com.google.common.base.Optional;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.server.computation.component.CrawlerDepthLimit;
import org.sonar.server.computation.formula.counter.IntSumCounter;
import org.sonar.server.computation.formula.counter.LongSumCounter;
import org.sonar.server.computation.formula.counter.SumCounter;
import org.sonar.server.computation.measure.Measure;

import static java.util.Objects.requireNonNull;

public abstract class SumFormula<T extends SumCounter<U, T>, U extends Number> implements Formula<T> {
    protected final String metricKey;
    @CheckForNull
    protected final U defaultInputValue;

    public SumFormula(String metricKey, @Nullable U defaultInputValue) {
        this.metricKey = requireNonNull(metricKey, "Metric key cannot be null");
        this.defaultInputValue = defaultInputValue;
    }

    public static IntSumFormula createIntSumFormula(String metricKey) {
        return createIntSumFormula(metricKey, null);
    }

    public static IntSumFormula createIntSumFormula(String metricKey, @Nullable Integer defaultInputValue) {
        return new IntSumFormula(metricKey, defaultInputValue);
    }

    public static class IntSumFormula extends SumFormula<IntSumCounter, Integer> {
        private IntSumFormula(String metricKey, @Nullable Integer defaultInputValue) {
            super(metricKey, defaultInputValue);
        }

        @Override
        public IntSumCounter createNewCounter() {
            return new IntSumCounter(metricKey, defaultInputValue);
        }

        @Override
        public Optional<Measure> createMeasure(IntSumCounter counter, CreateMeasureContext context) {
            Optional<Integer> valueOptional = counter.getValue();
            if (shouldCreateMeasure(context, valueOptional)) {
                return Optional.of(Measure.newMeasureBuilder().create(valueOptional.get()));
            }
            return Optional.absent();
        }
    }

    public static LongSumFormula createLongSumFormula(String metricKey) {
        return createLongSumFormula(metricKey, null);
    }

    public static LongSumFormula createLongSumFormula(String metricKey, @Nullable Long defaultInputValue) {
        return new LongSumFormula(metricKey, defaultInputValue);
    }

    public static class LongSumFormula extends SumFormula<LongSumCounter, Long> {
        private LongSumFormula(String metricKey, @Nullable Long defaultInputValue) {
            super(metricKey, defaultInputValue);
        }

        @Override
        public LongSumCounter createNewCounter() {
            return new LongSumCounter(metricKey, defaultInputValue);
        }

        @Override
        public Optional<Measure> createMeasure(LongSumCounter counter, CreateMeasureContext context) {
            Optional<Long> valueOptional = counter.getValue();
            if (shouldCreateMeasure(context, valueOptional)) {
                return Optional.of(Measure.newMeasureBuilder().create(valueOptional.get()));
            }
            return Optional.absent();
        }
    }

    private static <T extends Number> boolean shouldCreateMeasure(CreateMeasureContext context, Optional<T> value) {
        return value.isPresent() && CrawlerDepthLimit.LEAVES.isDeeperThan(context.getComponent().getType());
    }

    @Override
    public String[] getOutputMetricKeys() {
        return new String[] { metricKey };
    }
}