com.google.cloud.tools.opensource.dependencies

Class Bom

java.lang.Object

com.google.cloud.tools.opensource.dependencies.Bom

public final class Bom
extends Object

Constructor Summary

Constructors

Constructor and Description
Bom(String coordinates, com.google.common.collect.ImmutableList<org.eclipse.aether.artifact.Artifact> artifacts)

Method Summary

Modifier and Type	Method and Description
String	getCoordinates() Returns group:artifact:version.
com.google.common.collect.ImmutableList<org.eclipse.aether.artifact.Artifact>	getManagedDependencies() Returns the artifacts found in this BOM's managedDependencies section.
static Bom	readBom(Path pomFile)
static Bom	readBom(String coordinates) Parses the dependencyManagement section of an artifact and returns the artifacts included there.
static Bom	readBom(String coordinates, List<String> mavenRepositoryUrls) Parses the dependencyManagement section of an artifact and returns the artifacts included there.
static boolean	shouldSkipBomMember(org.eclipse.aether.artifact.Artifact artifact) Returns true if the artifact in BOM should be skipped for checks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Bom

public Bom(String coordinates,
           com.google.common.collect.ImmutableList<org.eclipse.aether.artifact.Artifact> artifacts)

Parameters:

coordinates - group:artifact:version

artifacts - the artifacts found in this BOM's managedDependencies section

Method Detail

getManagedDependencies

public com.google.common.collect.ImmutableList<org.eclipse.aether.artifact.Artifact> getManagedDependencies()

Returns the artifacts found in this BOM's managedDependencies section.

getCoordinates

public String getCoordinates()

Returns group:artifact:version.

readBom

public static Bom readBom(Path pomFile)
                   throws MavenRepositoryException

Throws:

MavenRepositoryException

readBom

public static Bom readBom(String coordinates,
                          List<String> mavenRepositoryUrls)
                   throws org.eclipse.aether.resolution.ArtifactDescriptorException

Parses the dependencyManagement section of an artifact and returns the artifacts included there.

Parameters:

mavenRepositoryUrls - URLs of Maven repositories to search for BOM members

Throws:

org.eclipse.aether.resolution.ArtifactDescriptorException

readBom

public static Bom readBom(String coordinates)
                   throws org.eclipse.aether.resolution.ArtifactDescriptorException

Parses the dependencyManagement section of an artifact and returns the artifacts included there.

Throws:

org.eclipse.aether.resolution.ArtifactDescriptorException

shouldSkipBomMember

public static boolean shouldSkipBomMember(org.eclipse.aether.artifact.Artifact artifact)

Returns true if the artifact in BOM should be skipped for checks.