Package org.cyclonedx.generators

Class AbstractBomGenerator

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.AbstractBomGenerator

Direct Known Subclasses:

BomJsonGenerator, BomXmlGenerator

public abstract class AbstractBomGenerator
extends CycloneDxSchema

Field Summary

Fields

Modifier and Type	Field	Description
protected Bom	bom
protected Format	format
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected Version	version

Fields inherited from class org.cyclonedx.CycloneDxSchema

ALL_VERSIONS, NS_BOM_10, NS_BOM_11, NS_BOM_12, NS_BOM_13, NS_BOM_14, NS_BOM_15, NS_BOM_16, NS_BOM_LATEST, NS_DEPENDENCY_GRAPH_10, VERSION_LATEST

Constructor Summary

Constructors

Constructor	Description
AbstractBomGenerator(Version version, Bom bom, Format format)

Method Summary

Modifier and Type	Method	Description
Format	getFormat()	Returns the format that this generator creates.
Version	getSchemaVersion()	Returns the version of the CycloneDX schema used by this instance
protected void	setupObjectMapper(boolean isXml)

Methods inherited from class org.cyclonedx.CycloneDxSchema

getJsonSchema, getXmlSchema, getXmlSchema

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

version

protected final Version version

bom

protected Bom bom

format

protected final Format format

Constructor Detail

AbstractBomGenerator

public AbstractBomGenerator(Version version,
                            Bom bom,
                            Format format)

Method Detail

getSchemaVersion

public Version getSchemaVersion()

Returns the version of the CycloneDX schema used by this instance

Returns:

a CycloneDxSchemaVersion enum

getFormat

public Format getFormat()

Returns the format that this generator creates.

Returns:

a Format enum

setupObjectMapper

protected void setupObjectMapper(boolean isXml)