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
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionvoidenterBom(org.eclipse.aether.artifact.Artifact bomArtifact) Called only once at the beginning of the processing to communicate the BOM artifact that is being analyzed.booleanenterReleaseOrigin(ScmRepository releaseOrigin, int versions) Called for every new detected release origin.voidleaveBom()Called after the last processed release version in the BOM.voidleaveReleaseOrigin(ScmRepository releaseOrigin) voidvisitProjectRelease(ProjectRelease release) Called for every new release version.protected abstract voidwriteEndBom(BufferedWriter writer) protected abstract voidwriteEndReleaseOrigin(BufferedWriter writer, ScmRepository releaseOrigin) protected abstract voidwriteProjectRelease(BufferedWriter writer, ProjectRelease release) protected abstract voidwriteStartBom(BufferedWriter writer, org.eclipse.aether.artifact.Artifact bomArtifact) protected abstract booleanwriteStartReleaseOrigin(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
-
Constructor Details
-
DecomposedBomReportFileWriter
-
DecomposedBomReportFileWriter
-
-
Method Details
-
enterBom
public void enterBom(org.eclipse.aether.artifact.Artifact bomArtifact) Description copied from interface:DecomposedBomVisitorCalled only once at the beginning of the processing to communicate the BOM artifact that is being analyzed.- Specified by:
enterBomin interfaceDecomposedBomVisitor- 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
Description copied from interface:DecomposedBomVisitorCalled for every new detected release origin. This callback method will be followed up by one or moreDecomposedBomVisitor.visitProjectRelease(ProjectRelease)invocations for each detected project release from this origin.- Specified by:
enterReleaseOriginin interfaceDecomposedBomVisitor- 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
- Specified by:
leaveReleaseOriginin interfaceDecomposedBomVisitor
-
writeEndReleaseOrigin
protected abstract void writeEndReleaseOrigin(BufferedWriter writer, ScmRepository releaseOrigin) throws IOException - Throws:
IOException
-
visitProjectRelease
Description copied from interface:DecomposedBomVisitorCalled for every new release version.- Specified by:
visitProjectReleasein interfaceDecomposedBomVisitor- 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:DecomposedBomVisitorCalled after the last processed release version in the BOM.- Specified by:
leaveBomin interfaceDecomposedBomVisitor
-
writeEndBom
- Throws:
IOException
-