org.sonar.server.computation.component.PathAwareVisitorAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * 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.server.computation.component;

import static java.util.Objects.requireNonNull;

/**
 * A adapter of the {@link PathAwareVisitor} to be able to visit only some component types
 */
public abstract class PathAwareVisitorAdapter implements PathAwareVisitor {
  private final CrawlerDepthLimit maxDepth;
  private final Order order;
  private final StackElementFactory factory;

  public PathAwareVisitorAdapter(CrawlerDepthLimit maxDepth, Order order, StackElementFactory factory) {
    this.maxDepth = requireNonNull(maxDepth);
    this.order = requireNonNull(order);
    this.factory = requireNonNull(factory, "Factory can not be null");
  }

  @Override
  public CrawlerDepthLimit getMaxDepth() {
    return maxDepth;
  }

  @Override
  public Order getOrder() {
    return order;
  }

  @Override
  public StackElementFactory getFactory() {
    return factory;
  }

  @Override
  public void visitProject(Component project, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitModule(Component module, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitDirectory(Component directory, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitFile(Component file, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitView(Component view, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitSubView(Component subView, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitProjectView(Component projectView, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  @Override
  public void visitAny(Component component, Path path) {
    // empty implementation, meant to be override at will by subclasses
  }

  /**
   * A Simple implementation which uses the same factory method for all types which can be implemented by subclasses:
   * {@link #createForAny(Component)}.
   */
  public abstract static class SimpleStackElementFactory implements StackElementFactory {

    public abstract T createForAny(Component component);

    @Override
    public T createForProject(Component project) {
      return createForAny(project);
    }

    @Override
    public T createForModule(Component module) {
      return createForAny(module);
    }

    @Override
    public T createForDirectory(Component directory) {
      return createForAny(directory);
    }

    @Override
    public T createForFile(Component file) {
      return createForAny(file);
    }

    @Override
    public T createForView(Component view) {
      return createForAny(view);
    }

    @Override
    public T createForSubView(Component subView) {
      return createForAny(subView);
    }

    @Override
    public T createForProjectView(Component projectView) {
      return createForAny(projectView);
    }

  }

}