From 4c156e49d47108b796ee723c326caff8e127076d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Boutemy?= Date: Tue, 16 Jan 2024 08:55:35 +0100 Subject: [PATCH] rename convert methohds to explicit project vs dependency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Hervé Boutemy --- src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java | 8 ++++---- .../java/org/cyclonedx/maven/CycloneDxAggregateMojo.java | 2 +- src/main/java/org/cyclonedx/maven/CycloneDxMojo.java | 2 +- .../java/org/cyclonedx/maven/CycloneDxPackageMojo.java | 2 +- .../java/org/cyclonedx/maven/DefaultModelConverter.java | 4 ++-- src/main/java/org/cyclonedx/maven/ModelConverter.java | 6 +++--- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java b/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java index fdc5537d..66ec078d 100644 --- a/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java +++ b/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java @@ -261,8 +261,8 @@ protected String generatePackageUrl(final Artifact artifact) { return modelConverter.generatePackageUrl(artifact); } - protected Component convert(Artifact artifact) { - return modelConverter.convert(artifact, schemaVersion(), includeLicenseText); + protected Component convertMavenDependency(Artifact artifact) { + return modelConverter.convertMavenDependency(artifact, schemaVersion(), includeLicenseText); } /** @@ -306,7 +306,7 @@ public void execute() throws MojoExecutionException { String analysis = extractComponentsAndDependencies(topLevelComponents, componentMap, dependencyMap); if (analysis != null) { - final Metadata metadata = modelConverter.convert(project, projectType, schemaVersion(), includeLicenseText, externalReferences); + final Metadata metadata = modelConverter.convertMavenProject(project, projectType, schemaVersion(), includeLicenseText, externalReferences); if (schemaVersion().getVersion() >= 1.3) { metadata.addProperty(newProperty("maven.goal", analysis)); @@ -486,7 +486,7 @@ protected void populateComponents(final Set topLevelComponents, final Ma final Component.Scope artifactScope = getComponentScope(artifact, dependencyAnalysis); final Component component = components.get(purl); if (component == null) { - final Component newComponent = convert(artifact); + final Component newComponent = convertMavenDependency(artifact); newComponent.setScope(artifactScope); components.put(purl, newComponent); } else if (!topLevelComponents.contains(purl)) { diff --git a/src/main/java/org/cyclonedx/maven/CycloneDxAggregateMojo.java b/src/main/java/org/cyclonedx/maven/CycloneDxAggregateMojo.java index ea5296f8..92e8f59b 100644 --- a/src/main/java/org/cyclonedx/maven/CycloneDxAggregateMojo.java +++ b/src/main/java/org/cyclonedx/maven/CycloneDxAggregateMojo.java @@ -125,7 +125,7 @@ protected String extractComponentsAndDependencies(final Set topLevelComp final BomDependencies bomDependencies = extractBOMDependencies(mavenProject); final Map projectDependencies = bomDependencies.getDependencies(); - final Component projectBomComponent = convert(mavenProject.getArtifact()); + final Component projectBomComponent = convertMavenDependency(mavenProject.getArtifact()); components.put(projectBomComponent.getPurl(), projectBomComponent); topLevelComponents.add(projectBomComponent.getPurl()); diff --git a/src/main/java/org/cyclonedx/maven/CycloneDxMojo.java b/src/main/java/org/cyclonedx/maven/CycloneDxMojo.java index a708dac2..397dc260 100644 --- a/src/main/java/org/cyclonedx/maven/CycloneDxMojo.java +++ b/src/main/java/org/cyclonedx/maven/CycloneDxMojo.java @@ -122,7 +122,7 @@ protected String extractComponentsAndDependencies(final Set topLevelComp final BomDependencies bomDependencies = extractBOMDependencies(getProject()); final Map projectDependencies = bomDependencies.getDependencies(); - final Component projectBomComponent = convert(getProject().getArtifact()); + final Component projectBomComponent = convertMavenDependency(getProject().getArtifact()); components.put(projectBomComponent.getPurl(), projectBomComponent); topLevelComponents.add(projectBomComponent.getPurl()); diff --git a/src/main/java/org/cyclonedx/maven/CycloneDxPackageMojo.java b/src/main/java/org/cyclonedx/maven/CycloneDxPackageMojo.java index ef4f5678..656ed222 100644 --- a/src/main/java/org/cyclonedx/maven/CycloneDxPackageMojo.java +++ b/src/main/java/org/cyclonedx/maven/CycloneDxPackageMojo.java @@ -65,7 +65,7 @@ protected String extractComponentsAndDependencies(Set topLevelComponents final BomDependencies bomDependencies = extractBOMDependencies(mavenProject); final Map projectDependencies = bomDependencies.getDependencies(); - final Component projectBomComponent = convert(mavenProject.getArtifact()); + final Component projectBomComponent = convertMavenDependency(mavenProject.getArtifact()); components.put(projectBomComponent.getPurl(), projectBomComponent); topLevelComponents.add(projectBomComponent.getPurl()); diff --git a/src/main/java/org/cyclonedx/maven/DefaultModelConverter.java b/src/main/java/org/cyclonedx/maven/DefaultModelConverter.java index 24249b0d..ad2d36f2 100644 --- a/src/main/java/org/cyclonedx/maven/DefaultModelConverter.java +++ b/src/main/java/org/cyclonedx/maven/DefaultModelConverter.java @@ -153,7 +153,7 @@ private String generatePackageUrl(String groupId, String artifactId, String vers } @Override - public Component convert(Artifact artifact, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText) { + public Component convertMavenDependency(Artifact artifact, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText) { final Component component = new Component(); component.setGroup(artifact.getGroupId()); component.setName(artifact.getArtifactId()); @@ -339,7 +339,7 @@ else if (licenseChoiceToResolve.getExpression() != null && CycloneDxSchema.Versi } @Override - public Metadata convert(final MavenProject project, String projectType, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText, ExternalReference[] externalReferences) { + public Metadata convertMavenProject(final MavenProject project, String projectType, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText, ExternalReference[] externalReferences) { final Tool tool = new Tool(); final Properties properties = readPluginProperties(); tool.setVendor(properties.getProperty("vendor")); diff --git a/src/main/java/org/cyclonedx/maven/ModelConverter.java b/src/main/java/org/cyclonedx/maven/ModelConverter.java index 77b9d72c..32ce8333 100644 --- a/src/main/java/org/cyclonedx/maven/ModelConverter.java +++ b/src/main/java/org/cyclonedx/maven/ModelConverter.java @@ -49,10 +49,10 @@ public interface ModelConverter { * @param includeLicenseText should license text be included in bom? * @return a CycloneDX component */ - Component convert(Artifact artifact, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText); + Component convertMavenDependency(Artifact artifact, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText); /** - * Converts a MavenProject into a Metadata object. + * Converts a MavenProject into a CycloneDX Metadata object. * * @param project the MavenProject to convert * @param projectType the target CycloneDX component type @@ -61,6 +61,6 @@ public interface ModelConverter { * @param externalReferences the external references * @return a CycloneDX Metadata object */ - Metadata convert(MavenProject project, String projectType, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText, ExternalReference[] externalReferences); + Metadata convertMavenProject(MavenProject project, String projectType, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText, ExternalReference[] externalReferences); }