org.sonar.api.ce.measure.RangeDistributionBuilder Maven / Gradle / Ivy
Show all versions of sonar-plugin-api Show documentation
/*
* Sonar Plugin API
* Copyright (C) 2009-2022 SonarSource SA
* mailto:info 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.api.ce.measure;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import javax.annotation.CheckForNull;
import org.sonar.api.utils.KeyValueFormat;
/**
* Utility to build a distribution based on defined ranges
*
*
An example of usage : you wish to record the percentage of lines of code that belong to method
* with pre-defined ranges of complexity.
*
* @since 5.2
*/
public class RangeDistributionBuilder {
private Map distributionSet;
private boolean isEmpty = true;
private Number[] bottomLimits;
private boolean isValid = true;
public RangeDistributionBuilder() {
// Nothing to be done here, bottom limits will be automatically calculated when adding the first value
}
/**
* RangeDistributionBuilder for a defined range
* Each entry is initialized at zero
*
* @param bottomLimits the bottom limits of ranges to be used
*/
public RangeDistributionBuilder(Number[] bottomLimits) {
init(bottomLimits);
}
/**
* Increments an entry by 1
*
* @param value the value to use to pick the entry to increment
*/
public RangeDistributionBuilder add(Number value) {
return add(value, 1);
}
/**
* Increments an entry
*
* @param value the value to use to pick the entry to increment
* @param count the number by which to increment
*/
public RangeDistributionBuilder add(Number value, int count) {
if (greaterOrEqualsThan(value, bottomLimits[0])) {
addValue(value, count);
isEmpty = false;
}
return this;
}
/**
* Adds an existing Distribution to the current one.
* It will create the entries if they don't exist.
* Can be used to add the values of children resources for example
*
* The returned distribution will be invalidated in case the given value does not use the same bottom limits
*
* @param data the data to add to the current one
*/
public RangeDistributionBuilder add(String data) {
Map map = KeyValueFormat.parse(data, KeyValueFormat.newDoubleConverter(), KeyValueFormat.newDoubleConverter());
if (bottomLimits == null) {
Number[] limits = map.keySet().toArray(new Number[map.size()]);
init(limits);
} else if (!areSameLimits(bottomLimits, map.keySet())) {
isValid = false;
}
if (isValid) {
for (Map.Entry entry : map.entrySet()) {
addLimitCount(entry.getKey(), entry.getValue().intValue());
}
}
return this;
}
private void init(Number[] bottomLimits) {
this.bottomLimits = new Number[bottomLimits.length];
System.arraycopy(bottomLimits, 0, this.bottomLimits, 0, this.bottomLimits.length);
Arrays.sort(this.bottomLimits);
changeDoublesToInts();
distributionSet = new TreeMap<>(NumberComparator.INSTANCE);
for (Number n : this.bottomLimits) {
distributionSet.put(n, 0);
}
}
private void changeDoublesToInts() {
for (Number bottomLimit : bottomLimits) {
if (NumberComparator.INSTANCE.compare(bottomLimit.intValue(), bottomLimit.doubleValue()) != 0) {
// it's not only ints
return;
}
}
for (int i = 0; i < bottomLimits.length; i++) {
bottomLimits[i] = bottomLimits[i].intValue();
}
}
private static boolean areSameLimits(Number[] bottomLimits, Set limits) {
if (limits.size() == bottomLimits.length) {
for (Number l : bottomLimits) {
if (!limits.contains(l.doubleValue())) {
return false;
}
}
return true;
}
return false;
}
private RangeDistributionBuilder addLimitCount(Number limit, int count) {
for (Number bottomLimit : bottomLimits) {
if (NumberComparator.INSTANCE.compare(bottomLimit.doubleValue(), limit.doubleValue()) == 0) {
addValue(limit, count);
isEmpty = false;
return this;
}
}
isValid = false;
return this;
}
private void addValue(Number value, int count) {
for (int i = bottomLimits.length - 1; i >= 0; i--) {
if (greaterOrEqualsThan(value, bottomLimits[i])) {
this.distributionSet.compute(bottomLimits[i], (k, v) -> v + count);
return;
}
}
}
/**
* @return whether the current object is empty or not
*/
public boolean isEmpty() {
return isEmpty;
}
/**
* Used to build a measure from the current object
*
* @return the built measure
*/
@CheckForNull
public String build() {
if (isValid) {
return KeyValueFormat.format(toMap());
}
return null;
}
private Map toMap() {
if (bottomLimits == null || bottomLimits.length == 0) {
return Collections.emptyMap();
}
return distributionSet;
}
private static boolean greaterOrEqualsThan(Number n1, Number n2) {
return NumberComparator.INSTANCE.compare(n1, n2) >= 0;
}
private enum NumberComparator implements Comparator {
INSTANCE;
@Override
public int compare(Number n1, Number n2) {
return Double.compare(n1.doubleValue(), n2.doubleValue());
}
}
}