org.sonar.scanner.scan.branch.ProjectBranches Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation

Open source platform for continuous inspection of code quality

There is a newer version: 24.12.0.100206

/*
 * SonarQube
 * 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.sonar.scanner.scan.branch;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import javax.annotation.CheckForNull;
import javax.annotation.concurrent.Immutable;

/**
 * Container class for information about the branches of a project.
 */
@Immutable
public class ProjectBranches {
  // matches server-side default when creating a project. See BranchDto#DEFAULT_MAIN_BRANCH_NAME
  private static final String DEFAULT_MAIN_BRANCH_NAME = "main";

  private final Map branches;
  private final String defaultBranchName;

  public ProjectBranches(List branchInfos) {
    this.branches = new HashMap<>();
    String mainBranchName = null;
    for (BranchInfo branch : branchInfos) {
      String branchName = branch.name();
      this.branches.put(branchName, branch);
      if (branch.isMain()) {
        mainBranchName = branchName;
      }
    }

    this.defaultBranchName = Objects.requireNonNullElse(mainBranchName, DEFAULT_MAIN_BRANCH_NAME);
  }

  @CheckForNull
  public BranchInfo get(String name) {
    return branches.get(name);
  }

  public boolean isEmpty() {
    return branches.isEmpty();
  }

  public String defaultBranchName() {
    return defaultBranchName;
  }
}