Package io.quarkus.bom.decomposer

Interface DecomposedBomVisitor

All Known Implementing Classes:

DecomposedBomHtmlReportGenerator, DecomposedBomReleasesLogger, DecomposedBomReportFileWriter, NoopDecomposedBomVisitor

public interface DecomposedBomVisitor

Callback that receives events on detected releases and their content

Method Summary

Modifier and Type	Method	Description
void	enterBom(org.eclipse.aether.artifact.Artifact bomArtifact)	Called only once at the beginning of the processing to communicate the BOM artifact that is being analyzed.
boolean	enterReleaseOrigin(ScmRepository releaseOrigin, int versions)	Called for every new detected release origin.
void	leaveBom()	Called after the last processed release version in the BOM.
void	leaveReleaseOrigin(ScmRepository releaseOrigin)
void	visitProjectRelease(ProjectRelease release)	Called for every new release version.

Method Detail

enterBom

void enterBom(org.eclipse.aether.artifact.Artifact bomArtifact)

Called only once at the beginning of the processing to communicate the BOM artifact that is being analyzed.

Parameters:

bomArtifact - BOM that is being analyzed

enterReleaseOrigin

boolean enterReleaseOrigin(ScmRepository releaseOrigin,
                           int versions)

Called for every new detected release origin. This callback method will be followed up by one or more visitProjectRelease(ProjectRelease) invocations for each detected project release from this origin.

Parameters:

releaseOrigin - new detected release origin

Returns:

whether to the detected project releases from this origin should be visited or not

leaveReleaseOrigin

void leaveReleaseOrigin(ScmRepository releaseOrigin)
                 throws BomDecomposerException

Throws:

BomDecomposerException

visitProjectRelease

void visitProjectRelease(ProjectRelease release)
                  throws BomDecomposerException

Called for every new release version.

Parameters:

release - project release

Throws:

BomDecomposerException - in case of failure

leaveBom

void leaveBom()
       throws BomDecomposerException

Called after the last processed release version in the BOM.

Throws:

BomDecomposerException - in case of a failure