com.google.cloud.tools.opensource.classpath.MissingDependency Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dependencies Show documentation

A library for analyzing Maven artifact dependency graphs

There is a newer version: 1.5.13

/*
 * Copyright 2020 Google LLC.
 *
 * 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.cloud.tools.opensource.classpath;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.cloud.tools.opensource.dependencies.DependencyPath;
import java.util.Objects;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.graph.Dependency;

/** An optional or provided-scope dependency is not supplied. */
class MissingDependency extends LinkageProblemCause {

  /**
   * The path from {@code LinkageProblem.sourceClass}'s artifact to an artifact that contains a
   * valid symbol.
   */
  protected DependencyPath pathToMissingArtifact;

  MissingDependency(DependencyPath pathToMissingArtifact) {
    this.pathToMissingArtifact = checkNotNull(pathToMissingArtifact);
  }

  DependencyPath getPathToMissingArtifact() {
    return pathToMissingArtifact;
  }

  @Override
  public String toString() {
    String missingReason = "";
    for (int i = 0; i < pathToMissingArtifact.size() - 1; i++) {
      Dependency dependency = pathToMissingArtifact.getDependency(i);
      if (dependency.isOptional()) {
        missingReason = " because the path contains an optional dependency";
        break;
      }
      if ("provided".equals(dependency.getScope())) {
        missingReason = " because the path contains a provided-scope dependency";
        break;
      }
    }
    Artifact artifactContainingValidSymbol = pathToMissingArtifact.getLeaf();
    return "The valid symbol is in "
        + artifactContainingValidSymbol
        + " at "
        + pathToMissingArtifact
        + " but it was not selected"
        + missingReason;
  }

  @Override
  public boolean equals(Object other) {
    if (this == other) {
      return true;
    }
    if (other == null || getClass() != other.getClass()) {
      return false;
    }
    MissingDependency that = (MissingDependency) other;
    return Objects.equals(pathToMissingArtifact, that.pathToMissingArtifact);
  }

  @Override
  public int hashCode() {
    return Objects.hash(pathToMissingArtifact);
  }
}