Package io.quarkus.bom.decomposer

Class DecomposedBomReportFileWriter

java.lang.Object

io.quarkus.bom.decomposer.FileReportWriter

io.quarkus.bom.decomposer.DecomposedBomReportFileWriter

All Implemented Interfaces:

DecomposedBomVisitor

Direct Known Subclasses:

DecomposedBomHtmlReportGenerator

public abstract class DecomposedBomReportFileWriter
extends FileReportWriter
implements DecomposedBomVisitor

Field Summary

Fields inherited from class io.quarkus.bom.decomposer.FileReportWriter

reportFile

Constructor Summary

Constructors

Constructor	Description
DecomposedBomReportFileWriter(String name)
DecomposedBomReportFileWriter(Path p)

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.
protected abstract void	writeEndBom(BufferedWriter writer)
protected abstract void	writeEndReleaseOrigin(BufferedWriter writer, ScmRepository releaseOrigin)
protected abstract void	writeProjectRelease(BufferedWriter writer, ProjectRelease release)
protected abstract void	writeStartBom(BufferedWriter writer, org.eclipse.aether.artifact.Artifact bomArtifact)
protected abstract boolean	writeStartReleaseOrigin(BufferedWriter writer, ScmRepository releaseOrigin, int versions)

Methods inherited from class io.quarkus.bom.decomposer.FileReportWriter

append, buf, close, closeTag, emptyTag, generateAnchor, indentChars, initWriter, isClosed, newLine, offset, offsetLine, openTag, openTag, writeAnchor, writeLine, writer, writeTag, writeTag

Methods inherited from class java.lang.Object

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

Constructor Detail

DecomposedBomReportFileWriter

public DecomposedBomReportFileWriter(String name)

DecomposedBomReportFileWriter

public DecomposedBomReportFileWriter(Path p)

Method Detail

enterBom

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

Description copied from interface: DecomposedBomVisitor

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

Specified by:

enterBom in interface DecomposedBomVisitor

Parameters:

bomArtifact - BOM that is being analyzed

writeStartBom

protected abstract void writeStartBom(BufferedWriter writer,
                                      org.eclipse.aether.artifact.Artifact bomArtifact)
                               throws IOException

Throws:

IOException

enterReleaseOrigin

public boolean enterReleaseOrigin(ScmRepository releaseOrigin,
                                  int versions)

Description copied from interface: DecomposedBomVisitor

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

Specified by:

enterReleaseOrigin in interface DecomposedBomVisitor

Parameters:

releaseOrigin - new detected release origin

Returns:

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

writeStartReleaseOrigin

protected abstract boolean writeStartReleaseOrigin(BufferedWriter writer,
                                                   ScmRepository releaseOrigin,
                                                   int versions)
                                            throws IOException

Throws:

IOException

leaveReleaseOrigin

public void leaveReleaseOrigin(ScmRepository releaseOrigin)

Specified by:

leaveReleaseOrigin in interface DecomposedBomVisitor

writeEndReleaseOrigin

protected abstract void writeEndReleaseOrigin(BufferedWriter writer,
                                              ScmRepository releaseOrigin)
                                       throws IOException

Throws:

IOException

visitProjectRelease

public void visitProjectRelease(ProjectRelease release)

Description copied from interface: DecomposedBomVisitor

Called for every new release version.

Specified by:

visitProjectRelease in interface DecomposedBomVisitor

Parameters:

release - project release

writeProjectRelease

protected abstract void writeProjectRelease(BufferedWriter writer,
                                            ProjectRelease release)
                                     throws IOException

Throws:

IOException

leaveBom

public void leaveBom()

Description copied from interface: DecomposedBomVisitor

Called after the last processed release version in the BOM.

Specified by:

leaveBom in interface DecomposedBomVisitor

writeEndBom

protected abstract void writeEndBom(BufferedWriter writer)
                             throws IOException

Throws:

IOException