org.sonarsource.sonarlint.ls.settings.WorkspaceSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-language-server Show documentation
SonarLint Language Server
There is a newer version: 3.12.0.75621
Show newest version
/*
 * SonarLint Language Server
 * Copyright (C) 2009-2024 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.sonarsource.sonarlint.ls.settings;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.sonarsource.sonarlint.core.commons.RuleKey;

/**
 * Settings global to the entire workspace (user + machine + workspace scopes)
 */
@Immutable
public class WorkspaceSettings {

  private final boolean disableTelemetry;
  private final Map connections;
  private final Collection excludedRules;
  private final Collection includedRules;
  private final Map> ruleParameters;
  private final boolean showAnalyzerLogs;
  private final boolean showVerboseLogs;
  private final String pathToNodeExecutable;
  private final boolean focusOnNewCode;

  private final String analysisExcludes;

  public WorkspaceSettings(boolean disableTelemetry, Map connections,
    Collection excludedRules, Collection includedRules, Map> ruleParameters,
    boolean showAnalyzerLogs, boolean showVerboseLogs, String pathToNodeExecutable, boolean focusOnNewCode, String analysisExcludes) {
    this.disableTelemetry = disableTelemetry;
    this.connections = connections;
    this.excludedRules = excludedRules;
    this.includedRules = includedRules;
    this.ruleParameters = ruleParameters;
    this.showAnalyzerLogs = showAnalyzerLogs;
    this.showVerboseLogs = showVerboseLogs;
    this.pathToNodeExecutable = pathToNodeExecutable;
    this.focusOnNewCode = focusOnNewCode;
    this.analysisExcludes = analysisExcludes;
  }

  public boolean isDisableTelemetry() {
    return disableTelemetry;
  }

  public Map getServerConnections() {
    return Collections.unmodifiableMap(connections);
  }

  public Collection getExcludedRules() {
    return excludedRules;
  }

  public Collection getIncludedRules() {
    return includedRules;
  }

  public Map> getRuleParameters() {
    return ruleParameters;
  }

  public boolean hasLocalRuleConfiguration() {
    return !excludedRules.isEmpty() || !includedRules.isEmpty();
  }

  public boolean showAnalyzerLogs() {
    return showAnalyzerLogs;
  }

  public boolean showVerboseLogs() {
    return showVerboseLogs;
  }

  public String pathToNodeExecutable() {
    return pathToNodeExecutable;
  }

  public boolean isFocusOnNewCode() {
    return focusOnNewCode;
  }

  public String getAnalysisExcludes() {
    return analysisExcludes;
  }

  @Override
  public int hashCode() {
    return Objects.hash(disableTelemetry, focusOnNewCode, connections, excludedRules, includedRules, showAnalyzerLogs, showVerboseLogs, pathToNodeExecutable);
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    var other = (WorkspaceSettings) obj;
    return disableTelemetry == other.disableTelemetry && focusOnNewCode == other.focusOnNewCode && Objects.equals(connections, other.connections)
      && Objects.equals(excludedRules, other.excludedRules)
      && Objects.equals(includedRules, other.includedRules) && Objects.equals(ruleParameters, other.ruleParameters)
      && Objects.equals(showAnalyzerLogs, other.showAnalyzerLogs) && Objects.equals(showVerboseLogs, other.showVerboseLogs)
      && Objects.equals(pathToNodeExecutable, other.pathToNodeExecutable);
  }

  @Override
  public String toString() {
    return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
  }

}