From 3c9e53b57a7d5a20d2f47d0462b53c10a587d250 Mon Sep 17 00:00:00 2001 From: Teryk Bellahsene Date: Fri, 22 May 2015 16:57:17 +0200 Subject: [PATCH] WS api/metrics/list - SONAR-6570 --- .../server/measure/persistence/MetricDao.java | 14 ++ .../sonar/server/measure/ws/ListAction.java | 128 ++++++++++++++ .../sonar/server/measure/ws/MetricsWs.java | 9 + .../server/measure/ws/MetricsWsAction.java | 27 +++ .../platformlevel/PlatformLevel4.java | 4 +- .../sonar/server/measure/ws/example-list.json | 23 +++ .../server/measure/ws/ListActionTest.java | 162 ++++++++++++++++++ .../server/measure/ws/MetricTesting.java | 54 ++++++ .../ws/ListActionTest/list_metrics.json | 25 +++ .../sonar/core/measure/db/MetricMapper.java | 5 +- .../sonar/core/measure/db/MetricMapper.xml | 9 + .../java/org/sonar/api/measures/Metric.java | 41 +++-- 12 files changed, 485 insertions(+), 16 deletions(-) create mode 100644 server/sonar-server/src/main/java/org/sonar/server/measure/ws/ListAction.java create mode 100644 server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWsAction.java create mode 100644 server/sonar-server/src/main/resources/org/sonar/server/measure/ws/example-list.json create mode 100644 server/sonar-server/src/test/java/org/sonar/server/measure/ws/ListActionTest.java create mode 100644 server/sonar-server/src/test/java/org/sonar/server/measure/ws/MetricTesting.java create mode 100644 server/sonar-server/src/test/resources/org/sonar/server/measure/ws/ListActionTest/list_metrics.json diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/persistence/MetricDao.java b/server/sonar-server/src/main/java/org/sonar/server/measure/persistence/MetricDao.java index 97758e56759..32bf681229d 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/persistence/MetricDao.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/persistence/MetricDao.java @@ -20,15 +20,20 @@ package org.sonar.server.measure.persistence; +import com.google.common.collect.Maps; +import org.apache.ibatis.session.RowBounds; import org.sonar.api.server.ServerSide; import org.sonar.core.measure.db.MetricDto; import org.sonar.core.measure.db.MetricMapper; import org.sonar.core.persistence.DaoComponent; import org.sonar.core.persistence.DbSession; +import org.sonar.server.es.SearchOptions; import javax.annotation.CheckForNull; +import javax.annotation.Nullable; import java.util.List; +import java.util.Map; @ServerSide public class MetricDao implements DaoComponent { @@ -42,6 +47,15 @@ public class MetricDao implements DaoComponent { return session.getMapper(MetricMapper.class).selectAllEnabled(); } + public List selectEnabled(DbSession session, @Nullable Boolean isCustom, SearchOptions searchOptions) { + Map properties = Maps.newHashMapWithExpectedSize(1); + if (isCustom != null) { + properties.put("isCustom", isCustom); + } + + return session.getMapper(MetricMapper.class).selectAllEnabled(properties, new RowBounds(searchOptions.getOffset(), searchOptions.getLimit())); + } + public void insert(DbSession session, MetricDto dto) { session.getMapper(MetricMapper.class).insert(dto); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/ListAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/ListAction.java new file mode 100644 index 00000000000..9ba67c1f013 --- /dev/null +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/ListAction.java @@ -0,0 +1,128 @@ +/* + * SonarQube, open source software quality management tool. + * Copyright (C) 2008-2014 SonarSource + * mailto:contact AT sonarsource DOT com + * + * SonarQube 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. + * + * SonarQube 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.measure.ws; + +import org.sonar.api.measures.Metric; +import org.sonar.api.server.ws.Request; +import org.sonar.api.server.ws.Response; +import org.sonar.api.server.ws.WebService; +import org.sonar.api.server.ws.WebService.Param; +import org.sonar.api.utils.text.JsonWriter; +import org.sonar.core.measure.db.MetricDto; +import org.sonar.core.persistence.DbSession; +import org.sonar.core.persistence.MyBatis; +import org.sonar.server.db.DbClient; +import org.sonar.server.es.SearchOptions; + +import javax.annotation.Nullable; + +import java.util.List; +import java.util.Set; + +import static com.google.common.collect.Sets.newHashSet; + +public class ListAction implements MetricsWsAction { + + public static final String PARAM_IS_CUSTOM = "is_custom"; + + public static final String FIELD_ID = "id"; + public static final String FIELD_KEY = "key"; + public static final String FIELD_NAME = "name"; + public static final String FIELD_DESCRIPTION = "description"; + public static final String FIELD_DOMAIN = "domain"; + public static final String FIELD_TYPE = "type"; + private static final Set POSSIBLE_FIELDS = newHashSet(FIELD_ID, FIELD_KEY, FIELD_NAME, FIELD_DESCRIPTION, FIELD_DOMAIN, FIELD_TYPE); + + private final DbClient dbClient; + + public ListAction(DbClient dbClient) { + this.dbClient = dbClient; + } + + @Override + public void define(WebService.NewController context) { + WebService.NewAction action = context.createAction("list") + .setSince("5.2") + .setResponseExample(getClass().getResource("example-list.json")) + .addPagingParams(100) + .addFieldsParam(POSSIBLE_FIELDS) + .setHandler(this); + + action.createParam(PARAM_IS_CUSTOM) + .setExampleValue("true") + .setDescription("Choose custom metrics following 3 cases:" + + "
    " + + "
  • true: only custom metrics are returned
    • " + + "
  • false: only non custom metrics are returned
    • " + + "
  • not specified: all metrics are returned
    • " + + "
"); + } + + @Override + public void handle(Request request, Response response) throws Exception { + SearchOptions searchOptions = new SearchOptions() + .setPage(request.mandatoryParamAsInt(Param.PAGE), + request.mandatoryParamAsInt(Param.PAGE_SIZE)); + Boolean isCustom = request.paramAsBoolean(PARAM_IS_CUSTOM); + DbSession dbSession = dbClient.openSession(false); + try { + List metrics = dbClient.metricDao().selectEnabled(dbSession, isCustom, searchOptions); + JsonWriter json = response.newJsonWriter(); + json.beginObject(); + Set desiredFields = desiredFields(request.paramAsStrings(Param.FIELDS)); + writeMetrics(json, metrics, desiredFields); + json.endObject(); + json.close(); + } finally { + MyBatis.closeQuietly(dbSession); + } + } + + private Set desiredFields(@Nullable List fields) { + if (fields == null || fields.isEmpty()) { + return POSSIBLE_FIELDS; + } + + return newHashSet(fields); + } + + private void writeMetrics(JsonWriter json, List metrics, Set desiredFields) { + json.name("metrics"); + json.beginArray(); + for (MetricDto metric : metrics) { + json.beginObject(); + json.prop(FIELD_ID, String.valueOf(metric.getId())); + json.prop(FIELD_KEY, metric.getKey()); + writeIfDesired(json, FIELD_NAME, metric.getShortName(), desiredFields); + writeIfDesired(json, FIELD_DESCRIPTION, metric.getDescription(), desiredFields); + writeIfDesired(json, FIELD_DOMAIN, metric.getDomain(), desiredFields); + writeIfDesired(json, FIELD_TYPE, Metric.ValueType.descriptionOf(metric.getValueType()), desiredFields); + json.endObject(); + } + json.endArray(); + } + + private void writeIfDesired(JsonWriter json, String field, String value, Set desiredFields) { + if (desiredFields.contains(field)) { + json.prop(field, value); + } + } +} diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWs.java b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWs.java index ed34355709b..2f352ef3bc6 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWs.java @@ -25,12 +25,21 @@ import org.sonar.api.server.ws.WebService; public class MetricsWs implements WebService { + private final MetricsWsAction[] actions; + + public MetricsWs(MetricsWsAction... actions) { + this.actions = actions; + } + @Override public void define(Context context) { NewController controller = context.createController("api/metrics"); controller.setDescription("Metrics management"); controller.setSince("2.6"); + for (MetricsWsAction action : actions) { + action.define(controller); + } defineIndexAction(controller); controller.done(); diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWsAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWsAction.java new file mode 100644 index 00000000000..61b28ba802b --- /dev/null +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MetricsWsAction.java @@ -0,0 +1,27 @@ +/* + * SonarQube, open source software quality management tool. + * Copyright (C) 2008-2014 SonarSource + * mailto:contact AT sonarsource DOT com + * + * SonarQube 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. + * + * SonarQube 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.measure.ws; + +import org.sonar.server.ws.WsAction; + +public interface MetricsWsAction extends WsAction { + // marker interface +} diff --git a/server/sonar-server/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java b/server/sonar-server/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java index a09daf2b385..a7af1692d96 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java +++ b/server/sonar-server/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java @@ -19,7 +19,6 @@ */ package org.sonar.server.platform.platformlevel; -import java.util.List; import org.sonar.api.config.EmailSettings; import org.sonar.api.issue.action.Actions; import org.sonar.api.profiles.AnnotationProfileParser; @@ -291,6 +290,8 @@ import org.sonar.server.view.index.ViewIndexer; import org.sonar.server.ws.ListingWs; import org.sonar.server.ws.WebServiceEngine; +import java.util.List; + public class PlatformLevel4 extends PlatformLevel { private final List level4AddedComponents; @@ -431,6 +432,7 @@ public class PlatformLevel4 extends PlatformLevel { TimeMachineWs.class, ManualMeasuresWs.class, MetricsWs.class, + org.sonar.server.measure.ws.ListAction.class, // quality gates QualityGateDao.class, diff --git a/server/sonar-server/src/main/resources/org/sonar/server/measure/ws/example-list.json b/server/sonar-server/src/main/resources/org/sonar/server/measure/ws/example-list.json new file mode 100644 index 00000000000..3a7a4ddd8d7 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/measure/ws/example-list.json @@ -0,0 +1,23 @@ +{ + "metrics": [ + { + "id": "23", + "key": "team_size", + "name": "Team size", + "description": "Number of people in the team", + "domain": "Management", + "type": "INT" + }, + { + "id": "2", + "key": "uncovered_lines", + "name": "Uncovered lines", + "description": "Uncovered lines", + "domain": "Tests", + "type": "INT" + } + ], + "total": 2, + "p": 1, + "ps": 100 +} diff --git a/server/sonar-server/src/test/java/org/sonar/server/measure/ws/ListActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/measure/ws/ListActionTest.java new file mode 100644 index 00000000000..4bbcb9b1406 --- /dev/null +++ b/server/sonar-server/src/test/java/org/sonar/server/measure/ws/ListActionTest.java @@ -0,0 +1,162 @@ +/* + * SonarQube, open source software quality management tool. + * Copyright (C) 2008-2014 SonarSource + * mailto:contact AT sonarsource DOT com + * + * SonarQube 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. + * + * SonarQube 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.measure.ws; + +import org.apache.commons.lang.StringUtils; +import org.junit.After; +import org.junit.Before; +import org.junit.ClassRule; +import org.junit.Test; +import org.sonar.api.server.ws.WebService.Param; +import org.sonar.core.measure.db.MetricDto; +import org.sonar.core.persistence.DbSession; +import org.sonar.core.persistence.DbTester; +import org.sonar.server.db.DbClient; +import org.sonar.server.measure.persistence.MetricDao; +import org.sonar.server.ws.WsTester; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.sonar.server.measure.ws.ListAction.PARAM_IS_CUSTOM; + +public class ListActionTest { + + @ClassRule + public static DbTester db = new DbTester(); + DbClient dbClient; + DbSession dbSession; + WsTester ws; + + @Before + public void setUp() { + dbClient = new DbClient(db.database(), db.myBatis(), new MetricDao()); + dbSession = dbClient.openSession(false); + ws = new WsTester(new MetricsWs(new ListAction(dbClient))); + db.truncateTables(); + } + + @After + public void tearDown() { + dbSession.close(); + } + + @Test + public void list_metrics_in_database() throws Exception { + insertNewCustomMetric("1", "2", "3"); + + WsTester.Result result = newRequest().execute(); + + result.assertJson(getClass(), "list_metrics.json"); + } + + @Test + public void list_metrics_ordered_by_name_case_insensitive() throws Exception { + insertNewCustomMetric("3", "1", "2"); + + String firstResult = newRequest().setParam(Param.PAGE, "1").setParam(Param.PAGE_SIZE, "1").execute().outputAsString(); + String secondResult = newRequest().setParam(Param.PAGE, "2").setParam(Param.PAGE_SIZE, "1").execute().outputAsString(); + String thirdResult = newRequest().setParam(Param.PAGE, "3").setParam(Param.PAGE_SIZE, "1").execute().outputAsString(); + + assertThat(firstResult).contains("custom-key-1").doesNotContain("custom-key-2").doesNotContain("custom-key-3"); + assertThat(secondResult).contains("custom-key-2").doesNotContain("custom-key-1").doesNotContain("custom-key-3"); + assertThat(thirdResult).contains("custom-key-3").doesNotContain("custom-key-1").doesNotContain("custom-key-2"); + } + + @Test + public void list_metrics_with_pagination() throws Exception { + insertNewCustomMetric("1", "2", "3", "4", "5", "6", "7", "8", "9", "10"); + + WsTester.Result result = newRequest() + .setParam(Param.PAGE, "3") + .setParam(Param.PAGE_SIZE, "4") + .execute(); + + assertThat(StringUtils.countMatches(result.outputAsString(), "custom-key")).isEqualTo(2); + } + + @Test + public void list_metric_with_is_custom_true() throws Exception { + insertNewCustomMetric("1", "2"); + insertNewNonCustomMetric("3"); + + String result = newRequest() + .setParam(PARAM_IS_CUSTOM, "true").execute().outputAsString(); + + assertThat(result).contains("custom-key-1", "custom-key-2") + .doesNotContain("non-custom-key-3"); + } + + @Test + public void list_metric_with_is_custom_false() throws Exception { + insertNewCustomMetric("1", "2"); + insertNewNonCustomMetric("3"); + + String result = newRequest() + .setParam(PARAM_IS_CUSTOM, "false").execute().outputAsString(); + + assertThat(result).doesNotContain("custom-key-1") + .doesNotContain("custom-key-2") + .contains("non-custom-key-3"); + } + + @Test + public void list_metric_with_chosen_fields() throws Exception { + insertNewCustomMetric("1"); + + String result = newRequest().setParam(Param.FIELDS, "name").execute().outputAsString(); + + assertThat(result).contains("id", "key", "name") + .doesNotContain("domain") + .doesNotContain("description") + .doesNotContain("type"); + } + + private void insertNewNonCustomMetric(String... ids) { + for (String id : ids) { + dbClient.metricDao().insert(dbSession, MetricTesting.newDto() + .setKey("non-custom-key-" + id) + .setEnabled(true) + .setUserManaged(false)); + } + dbSession.commit(); + } + + private void insertNewCustomMetric(String... ids) { + for (String id : ids) { + dbClient.metricDao().insert(dbSession, newCustomMetric(id)); + } + dbSession.commit(); + } + + private MetricDto newCustomMetric(String id) { + return MetricTesting.newDto() + .setKey("custom-key-" + id) + .setShortName("custom-name-" + id) + .setDomain("custom-domain-" + id) + .setDescription("custom-description-" + id) + .setValueType("INT") + .setUserManaged(true) + .setEnabled(true); + } + + private WsTester.TestRequest newRequest() { + return ws.newGetRequest("api/metrics", "list"); + } +} diff --git a/server/sonar-server/src/test/java/org/sonar/server/measure/ws/MetricTesting.java b/server/sonar-server/src/test/java/org/sonar/server/measure/ws/MetricTesting.java new file mode 100644 index 00000000000..753faf4689c --- /dev/null +++ b/server/sonar-server/src/test/java/org/sonar/server/measure/ws/MetricTesting.java @@ -0,0 +1,54 @@ +/* + * SonarQube, open source software quality management tool. + * Copyright (C) 2008-2014 SonarSource + * mailto:contact AT sonarsource DOT com + * + * SonarQube 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. + * + * SonarQube 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.measure.ws; + +import org.apache.commons.lang.RandomStringUtils; +import org.apache.commons.lang.math.RandomUtils; +import org.sonar.api.measures.Metric; +import org.sonar.core.measure.db.MetricDto; + +public class MetricTesting { + private MetricTesting() { + // static stuff only + } + + public static MetricDto newDto() { + Metric.ValueType[] metricTypes = Metric.ValueType.values(); + return new MetricDto() + .setId(RandomUtils.nextInt()) + .setKey(RandomStringUtils.randomAlphanumeric(64)) + .setShortName(RandomStringUtils.randomAlphanumeric(64)) + .setValueType(metricTypes[RandomUtils.nextInt(metricTypes.length - 1)].name()) + .setDomain(RandomStringUtils.randomAlphanumeric(64)) + .setDescription(RandomStringUtils.randomAlphanumeric(250)) + .setBestValue(RandomUtils.nextDouble()) + .setDeleteHistoricalData(RandomUtils.nextBoolean()) + .setDirection(RandomUtils.nextInt()) + .setHidden(RandomUtils.nextBoolean()) + .setEnabled(RandomUtils.nextBoolean()) + .setOptimizedBestValue(RandomUtils.nextBoolean()) + .setQualitative(RandomUtils.nextBoolean()) + .setOrigin(RandomStringUtils.randomAlphabetic(3)) + .setUserManaged(RandomUtils.nextBoolean()) + .setWorstValue(RandomUtils.nextDouble()); + } + +} diff --git a/server/sonar-server/src/test/resources/org/sonar/server/measure/ws/ListActionTest/list_metrics.json b/server/sonar-server/src/test/resources/org/sonar/server/measure/ws/ListActionTest/list_metrics.json new file mode 100644 index 00000000000..4f5049c8aeb --- /dev/null +++ b/server/sonar-server/src/test/resources/org/sonar/server/measure/ws/ListActionTest/list_metrics.json @@ -0,0 +1,25 @@ +{ + "metrics":[ + { + "key":"custom-key-1", + "name":"custom-name-1", + "type":"Integer", + "domain":"custom-domain-1", + "description":"custom-description-1" + }, + { + "key":"custom-key-2", + "name":"custom-name-2", + "type":"Integer", + "domain":"custom-domain-2", + "description":"custom-description-2" + }, + { + "key":"custom-key-3", + "name":"custom-name-3", + "type":"Integer", + "domain":"custom-domain-3", + "description":"custom-description-3" + } + ] +} diff --git a/sonar-core/src/main/java/org/sonar/core/measure/db/MetricMapper.java b/sonar-core/src/main/java/org/sonar/core/measure/db/MetricMapper.java index 4ecec87bccb..16b737866fc 100644 --- a/sonar-core/src/main/java/org/sonar/core/measure/db/MetricMapper.java +++ b/sonar-core/src/main/java/org/sonar/core/measure/db/MetricMapper.java @@ -21,15 +21,16 @@ package org.sonar.core.measure.db; import org.apache.ibatis.annotations.Param; +import org.apache.ibatis.session.RowBounds; import java.util.List; +import java.util.Map; public interface MetricMapper { MetricDto selectByKey(@Param("key") String key); - List selectAllEnabled(); - + List selectAllEnabled(Map properties, RowBounds rowBounds); void insert(MetricDto dto); } diff --git a/sonar-core/src/main/resources/org/sonar/core/measure/db/MetricMapper.xml b/sonar-core/src/main/resources/org/sonar/core/measure/db/MetricMapper.xml index add84117d0a..77757491d88 100644 --- a/sonar-core/src/main/resources/org/sonar/core/measure/db/MetricMapper.xml +++ b/sonar-core/src/main/resources/org/sonar/core/measure/db/MetricMapper.xml @@ -37,7 +37,16 @@ FROM metrics m AND m.enabled=${_true} + + + AND m.user_managed=${_true} + + + AND m.user_managed=${_false} + + + ORDER BY UPPER(m.short_name) diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java index 95035b48bcd..6c98862765d 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java @@ -23,8 +23,8 @@ import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.builder.ReflectionToStringBuilder; import org.apache.commons.lang.builder.ToStringStyle; import org.sonar.api.batch.BatchSide; -import org.sonar.api.server.ServerSide; import org.sonar.api.batch.InstantiationStrategy; +import org.sonar.api.server.ServerSide; import javax.annotation.CheckForNull; import javax.annotation.Nullable; @@ -65,28 +65,43 @@ public class Metric implements Serializable, org.sonar.a public static final int DIRECTION_NONE = 0; public enum ValueType { - INT(Integer.class), - FLOAT(Double.class), - PERCENT(Double.class), - BOOL(Boolean.class), - STRING(String.class), - MILLISEC(Integer.class), - DATA(String.class), - LEVEL(Metric.Level.class), - DISTRIB(String.class), - RATING(Integer.class), - WORK_DUR(Long.class); + INT(Integer.class, "Integer"), + FLOAT(Double.class, "Float"), + PERCENT(Double.class, "Percent"), + BOOL(Boolean.class, "Yes/No"), + STRING(String.class, "String"), + MILLISEC(Integer.class, "Milliseconds"), + DATA(String.class, "Data"), + LEVEL(Metric.Level.class, "Level"), + DISTRIB(String.class, "Distribution"), + RATING(Integer.class, "Rating"), + WORK_DUR(Long.class, "Work Duration"); private final Class valueClass; + private final String description; - private ValueType(Class valueClass) { + ValueType(Class valueClass, String description) { this.valueClass = valueClass; + this.description = description; } private Class valueType() { return valueClass; } + public String description() { + return description; + } + + public static String descriptionOf(String key) { + for (ValueType valueType : values()) { + if (valueType.name().equals(key)) { + return valueType.description; + } + } + + throw new IllegalArgumentException(String.format("Unknown ValueType key '%s'", key)); + } } public enum Level { -- 2.39.5