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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2022 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program 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  * This program 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 package org.sonar.ce.task.projectanalysis.component;
  21
  22 import com.google.common.base.MoreObjects;
  23 import com.google.common.collect.ImmutableList;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26 import javax.annotation.CheckForNull;
  27 import javax.annotation.Nullable;
  28 import javax.annotation.concurrent.Immutable;
  29
  30 import static com.google.common.base.Preconditions.checkArgument;
  31 import static com.google.common.base.Preconditions.checkState;
  32 import static java.util.Objects.requireNonNull;
  33 import static org.apache.commons.lang.StringUtils.abbreviate;
  34 import static org.apache.commons.lang.StringUtils.trimToNull;
  35 import static org.sonar.db.component.ComponentValidator.MAX_COMPONENT_DESCRIPTION_LENGTH;
  36 import static org.sonar.db.component.ComponentValidator.MAX_COMPONENT_NAME_LENGTH;
  37
  38 @Immutable
  39 public class ComponentImpl implements Component {
  40   private final Type type;
  41   private final Status status;
  42   private final String name;
  43   private final String shortName;
  44   private final String key;
  45   private final String uuid;
  46
  47   @CheckForNull
  48   private final String description;
  49   private final List<Component> children;
  50   @CheckForNull
  51   private final ProjectAttributes projectAttributes;
  52   private final ReportAttributes reportAttributes;
  53   @CheckForNull
  54   private final FileAttributes fileAttributes;
  55
  56   private ComponentImpl(Builder builder) {
  57     this.type = builder.type;
  58     this.status = builder.status;
  59     this.key = builder.key;
  60     this.name = builder.name;
  61     this.shortName = MoreObjects.firstNonNull(builder.shortName, builder.name).intern();
  62     this.description = builder.description;
  63     this.uuid = builder.uuid;
  64     this.projectAttributes = builder.projectAttributes;
  65     this.reportAttributes = builder.reportAttributes;
  66     this.fileAttributes = builder.fileAttributes;
  67     this.children = ImmutableList.copyOf(builder.children);
  68   }
  69
  70   @Override
  71   public Type getType() {
  72     return type;
  73   }
  74
  75   @Override
  76   public Status getStatus() {
  77     return status;
  78   }
  79
  80   @Override
  81   public String getUuid() {
  82     return uuid;
  83   }
  84
  85   @Override
  86   public String getKey() {
  87     return key;
  88   }
  89
  90   @Override
  91   public String getName() {
  92     return this.name;
  93   }
  94
  95   @Override
  96   public String getOldName() {
  97     return this.getFileAttributes().getOldName();
  98   }
  99
 100   @Override
 101   public String getShortName() {
 102     return this.shortName;
 103   }
 104
 105   @Override
 106   @CheckForNull
 107   public String getDescription() {
 108     return this.description;
 109   }
 110
 111   @Override
 112   public List<Component> getChildren() {
 113     return children;
 114   }
 115
 116   @Override
 117   public ProjectAttributes getProjectAttributes() {
 118     checkState(this.type == Type.PROJECT, "Only component of type PROJECT have a ProjectAttributes object");
 119     return this.projectAttributes;
 120   }
 121
 122   @Override
 123   public ReportAttributes getReportAttributes() {
 124     return this.reportAttributes;
 125   }
 126
 127   @Override
 128   public FileAttributes getFileAttributes() {
 129     checkState(this.type == Type.FILE, "Only component of type FILE have a FileAttributes object");
 130     return this.fileAttributes;
 131   }
 132
 133   @Override
 134   public ProjectViewAttributes getProjectViewAttributes() {
 135     throw new IllegalStateException("Only component of type PROJECT_VIEW have a ProjectViewAttributes object");
 136   }
 137
 138   @Override
 139   public SubViewAttributes getSubViewAttributes() {
 140     throw new IllegalStateException("Only component of type SUBVIEW have a SubViewAttributes object");
 141   }
 142
 143   @Override
 144   public ViewAttributes getViewAttributes() {
 145     throw new IllegalStateException("Only component of type VIEW have a ViewAttributes object");
 146   }
 147
 148   public static Builder builder(Type type) {
 149     return new Builder(type);
 150   }
 151
 152   public static final class Builder {
 153
 154     private static final String KEY_CANNOT_BE_NULL = "Key can't be null";
 155     private static final String UUID_CANNOT_BE_NULL = "uuid can't be null";
 156     private static final String REPORT_ATTRIBUTES_CANNOT_BE_NULL = "reportAttributes can't be null";
 157     private static final String NAME_CANNOT_BE_NULL = "name can't be null";
 158     private static final String STATUS_CANNOT_BE_NULL = "status can't be null";
 159
 160     private final Type type;
 161     private Status status;
 162     private ProjectAttributes projectAttributes;
 163     private ReportAttributes reportAttributes;
 164     private String uuid;
 165     private String key;
 166     private String name;
 167     private String oldName;
 168     private String shortName;
 169     private String description;
 170     private FileAttributes fileAttributes;
 171     private final List<Component> children = new ArrayList<>();
 172
 173     private Builder(Type type) {
 174       this.type = requireNonNull(type, "type can't be null");
 175     }
 176
 177     public Builder setUuid(String s) {
 178       this.uuid = requireNonNull(s, UUID_CANNOT_BE_NULL);
 179       return this;
 180     }
 181
 182     @CheckForNull
 183     public String getUuid() {
 184       return uuid;
 185     }
 186
 187     public Builder setStatus(Status status) {
 188       this.status = requireNonNull(status, STATUS_CANNOT_BE_NULL);
 189       return this;
 190     }
 191
 192     public Builder setKey(String key) {
 193       this.key = requireNonNull(key, KEY_CANNOT_BE_NULL);
 194       return this;
 195     }
 196
 197     public Builder setName(String name) {
 198       this.name = abbreviate(requireNonNull(name, NAME_CANNOT_BE_NULL), MAX_COMPONENT_NAME_LENGTH);
 199       return this;
 200     }
 201
 202     public Builder setShortName(String shortName) {
 203       this.shortName = abbreviate(requireNonNull(shortName, NAME_CANNOT_BE_NULL), MAX_COMPONENT_NAME_LENGTH);
 204       return this;
 205     }
 206
 207     public Builder setDescription(@Nullable String description) {
 208       this.description = abbreviate(trimToNull(description), MAX_COMPONENT_DESCRIPTION_LENGTH);
 209       return this;
 210     }
 211
 212     public Builder setProjectAttributes(ProjectAttributes projectAttributes) {
 213       checkProjectAttributes(projectAttributes);
 214       this.projectAttributes = projectAttributes;
 215       return this;
 216     }
 217
 218     public Builder setReportAttributes(ReportAttributes reportAttributes) {
 219       this.reportAttributes = requireNonNull(reportAttributes, REPORT_ATTRIBUTES_CANNOT_BE_NULL);
 220       return this;
 221     }
 222
 223     public Builder setFileAttributes(@Nullable FileAttributes fileAttributes) {
 224       this.fileAttributes = fileAttributes;
 225       return this;
 226     }
 227
 228     public Builder addChildren(List<Component> components) {
 229       for (Component component : components) {
 230         checkArgument(component.getType().isReportType());
 231       }
 232       this.children.addAll(components);
 233       return this;
 234     }
 235
 236     public ComponentImpl build() {
 237       requireNonNull(reportAttributes, REPORT_ATTRIBUTES_CANNOT_BE_NULL);
 238       requireNonNull(uuid, UUID_CANNOT_BE_NULL);
 239       requireNonNull(key, KEY_CANNOT_BE_NULL);
 240       requireNonNull(name, NAME_CANNOT_BE_NULL);
 241       requireNonNull(status, STATUS_CANNOT_BE_NULL);
 242       checkProjectAttributes(this.projectAttributes);
 243       return new ComponentImpl(this);
 244     }
 245
 246     private void checkProjectAttributes(@Nullable ProjectAttributes projectAttributes) {
 247       checkArgument(type != Type.PROJECT ^ projectAttributes != null, "ProjectAttributes must and can only be set for type PROJECT");
 248     }
 249   }
 250
 251   @Override
 252   public String toString() {
 253     return "ComponentImpl{" +
 254       "type=" + type +
 255       ", status=" + status +
 256       ", name='" + name + '\'' +
 257       ", key='" + key + '\'' +
 258       ", uuid='" + uuid + '\'' +
 259       ", description='" + description + '\'' +
 260       ", children=" + children +
 261       ", projectAttributes=" + projectAttributes +
 262       ", reportAttributes=" + reportAttributes +
 263       ", fileAttributes=" + fileAttributes +
 264       '}';
 265   }
 266
 267   @Override
 268   public boolean equals(@Nullable Object o) {
 269     if (this == o) {
 270       return true;
 271     }
 272     if (o == null || getClass() != o.getClass()) {
 273       return false;
 274     }
 275     ComponentImpl component = (ComponentImpl) o;
 276     return uuid.equals(component.uuid);
 277   }
 278
 279   @Override
 280   public int hashCode() {
 281     return uuid.hashCode();
 282   }
 283 }