org.sonar.batch.index.BatchComponent 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: 25.1.0.102122

/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact 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.batch.index;

import java.util.ArrayList;
import java.util.Collection;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.batch.fs.InputComponent;
import org.sonar.api.resources.Resource;
import org.sonar.api.resources.ResourceUtils;

public class BatchComponent {

  private final int batchId;
  private final Resource r;
  private final BatchComponent parent;
  private final Collection children = new ArrayList<>();
  private InputComponent inputComponent;

  public BatchComponent(int batchId, Resource r, @Nullable BatchComponent parent) {
    this.batchId = batchId;
    this.r = r;
    this.parent = parent;
    if (parent != null) {
      parent.children.add(this);
    }
  }

  public String key() {
    return r.getEffectiveKey();
  }

  public int batchId() {
    return batchId;
  }

  public Resource resource() {
    return r;
  }

  @CheckForNull
  public BatchComponent parent() {
    return parent;
  }

  public Collection children() {
    return children;
  }

  public boolean isFile() {
    return this.inputComponent.isFile();
  }

  public BatchComponent setInputComponent(InputComponent inputComponent) {
    this.inputComponent = inputComponent;
    return this;
  }

  public InputComponent inputComponent() {
    return inputComponent;
  }

  public boolean isProjectOrModule() {
    return ResourceUtils.isProject(r);
  }
}