source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube, open source software quality management tool.
   3  * Copyright (C) 2008-2014 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * SonarQube is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * SonarQube is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20
  21 package org.sonar.api.server.debt.internal;
  22
  23 import com.google.common.base.Objects;
  24 import org.apache.commons.lang.StringUtils;
  25 import org.apache.commons.lang.builder.EqualsBuilder;
  26 import org.sonar.api.server.debt.DebtRemediationFunction;
  27 import org.sonar.api.utils.Duration;
  28
  29 import javax.annotation.CheckForNull;
  30 import javax.annotation.Nullable;
  31
  32 public class DefaultDebtRemediationFunction implements DebtRemediationFunction {
  33
  34   private static final int HOURS_IN_DAY = 24;
  35
  36   private final Type type;
  37   private final String coefficient;
  38   private final String offset;
  39
  40   public DefaultDebtRemediationFunction(@Nullable Type type, @Nullable String coefficient, @Nullable String offset) {
  41     this.type = type;
  42     this.coefficient = sanitizeValue("coefficient", coefficient);
  43     this.offset = sanitizeValue("offset", offset);
  44     validate();
  45   }
  46
  47   @CheckForNull
  48   private String sanitizeValue(String label, @Nullable String s) {
  49     if (StringUtils.isNotBlank(s)) {
  50       try {
  51         Duration duration = Duration.decode(s, HOURS_IN_DAY);
  52         return duration.encode(HOURS_IN_DAY);
  53       } catch (Exception e) {
  54         throw new IllegalArgumentException(String.format("Invalid %s: %s", label, s), e);
  55       }
  56     }
  57     return null;
  58   }
  59
  60   @Override
  61   public Type type() {
  62     return type;
  63   }
  64
  65   @Override
  66   @CheckForNull
  67   public String coefficient() {
  68     return coefficient;
  69   }
  70
  71   @Override
  72   @CheckForNull
  73   public String offset() {
  74     return offset;
  75   }
  76
  77   private void validate() {
  78     if (type == null) {
  79       throw new IllegalArgumentException("Remediation function type cannot be null");
  80     }
  81     switch (type) {
  82       case LINEAR:
  83         if (this.coefficient == null || this.offset != null) {
  84           throw new IllegalArgumentException(String.format("Only coefficient must be set on %s", this));
  85         }
  86         break;
  87       case LINEAR_OFFSET:
  88         if (this.coefficient == null || this.offset == null) {
  89           throw new IllegalArgumentException(String.format("Both coefficient and offset are required on %s", this));
  90         }
  91         break;
  92       case CONSTANT_ISSUE:
  93         if (this.coefficient != null || this.offset == null) {
  94           throw new IllegalArgumentException(String.format("Only offset must be set on %s", this));
  95         }
  96         break;
  97       default:
  98         throw new IllegalArgumentException(String.format("Unknown type on %s", this));
  99     }
 100   }
 101
 102   @Override
 103   public boolean equals(Object o) {
 104     if (!(o instanceof DefaultDebtRemediationFunction)) {
 105       return false;
 106     }
 107     if (this == o) {
 108       return true;
 109     }
 110     DefaultDebtRemediationFunction other = (DefaultDebtRemediationFunction) o;
 111     return new EqualsBuilder()
 112       .append(coefficient, other.coefficient())
 113       .append(offset, other.offset())
 114       .append(type, other.type())
 115       .isEquals();
 116   }
 117
 118   @Override
 119   public int hashCode() {
 120     int result = type.hashCode();
 121     result = 31 * result + (coefficient != null ? coefficient.hashCode() : 0);
 122     result = 31 * result + (offset != null ? offset.hashCode() : 0);
 123     return result;
 124   }
 125
 126   @Override
 127   public String toString() {
 128     return Objects.toStringHelper(DebtRemediationFunction.class)
 129       .add("type", type)
 130       .add("coefficient", coefficient)
 131       .add("offset", offset)
 132       .toString();
 133   }
 134 }