java/com/google/gerrit/common/data/SubscribeSection.java

// Copyright (C) 2016 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.common.data;

import com.google.gerrit.entities.BranchNameKey;
import com.google.gerrit.entities.Project;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.eclipse.jgit.transport.RefSpec;

/** Portion of a {@link Project} describing superproject subscription rules. */
public class SubscribeSection {

  private final List<RefSpec> multiMatchRefSpecs;
  private final List<RefSpec> matchingRefSpecs;
  private final Project.NameKey project;

  public SubscribeSection(Project.NameKey p) {
    project = p;
    matchingRefSpecs = new ArrayList<>();
    multiMatchRefSpecs = new ArrayList<>();
  }

  public void addMatchingRefSpec(RefSpec spec) {
    matchingRefSpecs.add(spec);
  }

  public void addMatchingRefSpec(String spec) {
    RefSpec r = new RefSpec(spec);
    matchingRefSpecs.add(r);
  }

  public void addMultiMatchRefSpec(String spec) {
    RefSpec r = new RefSpec(spec, RefSpec.WildcardMode.ALLOW_MISMATCH);
    multiMatchRefSpecs.add(r);
  }

  public Project.NameKey getProject() {
    return project;
  }

  /**
   * Determines if the <code>branch</code> could trigger a superproject update as allowed via this
   * subscribe section.
   *
   * @param branch the branch to check
   * @return if the branch could trigger a superproject update
   */
  public boolean appliesTo(BranchNameKey branch) {
    for (RefSpec r : matchingRefSpecs) {
      if (r.matchSource(branch.branch())) {
        return true;
      }
    }
    for (RefSpec r : multiMatchRefSpecs) {
      if (r.matchSource(branch.branch())) {
        return true;
      }
    }
    return false;
  }

  public Collection<RefSpec> getMatchingRefSpecs() {
    return Collections.unmodifiableCollection(matchingRefSpecs);
  }

  public Collection<RefSpec> getMultiMatchRefSpecs() {
    return Collections.unmodifiableCollection(multiMatchRefSpecs);
  }

  @Override
  public String toString() {
    StringBuilder ret = new StringBuilder();
    ret.append("[SubscribeSection, project=");
    ret.append(project);
    if (!matchingRefSpecs.isEmpty()) {
      ret.append(", matching=[");
      for (RefSpec r : matchingRefSpecs) {
        ret.append(r.toString());
        ret.append(", ");
      }
    }
    if (!multiMatchRefSpecs.isEmpty()) {
      ret.append(", all=[");
      for (RefSpec r : multiMatchRefSpecs) {
        ret.append(r.toString());
        ret.append(", ");
      }
    }
    ret.append("]");
    return ret.toString();
  }
}