org.cyclonedx.generators.xml

Class BomXmlGenerator13

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.xml.AbstractBomXmlGenerator

org.cyclonedx.generators.xml.BomXmlGenerator13

All Implemented Interfaces:

BomXmlGenerator

public class BomXmlGenerator13
extends AbstractBomXmlGenerator
implements BomXmlGenerator

BomGenerator creates a CycloneDX bill-of-material document from a set of Components. Proper usage assumes generate() is called after construction and optionally followed by toXmlString().

Since:

5.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclonedx.CycloneDxSchema

CycloneDxSchema.Version

Field Summary

Fields inherited from class org.cyclonedx.generators.xml.AbstractBomXmlGenerator

PROLOG

Fields inherited from class org.cyclonedx.CycloneDxSchema

NS_BOM_10, NS_BOM_11, NS_BOM_12, NS_BOM_13, NS_BOM_14, NS_BOM_LATEST, NS_DEPENDENCY_GRAPH_10, VERSION_LATEST

Constructor Summary

Constructors

Constructor and Description
BomXmlGenerator13(Bom bom) Constructs a new BomGenerator object.

Method Summary

Modifier and Type	Method and Description
Document	generate() Creates a CycloneDX BoM from a set of Components.
CycloneDxSchema.Version	getSchemaVersion() Returns the version of the CycloneDX schema used by this instance
String	toXmlString()

Methods inherited from class org.cyclonedx.generators.xml.AbstractBomXmlGenerator

buildSecureDocumentBuilder, generateDocument, getMapper, toString

Methods inherited from class org.cyclonedx.CycloneDxSchema

getJsonSchema, getXmlSchema, getXmlSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclonedx.generators.xml.BomXmlGenerator

toString

Constructor Detail

BomXmlGenerator13

public BomXmlGenerator13(Bom bom)

Constructs a new BomGenerator object.

Parameters:

bom - the BOM to generate

Method Detail

getSchemaVersion

public CycloneDxSchema.Version getSchemaVersion()

Returns the version of the CycloneDX schema used by this instance

Specified by:

getSchemaVersion in interface BomXmlGenerator

Returns:

a CycloneDxSchemaVersion enum

generate

public Document generate()
                  throws ParserConfigurationException

Creates a CycloneDX BoM from a set of Components.

Specified by:

generate in interface BomXmlGenerator

Returns:

an XML Document representing a CycloneDX BoM

Throws:

ParserConfigurationException

Since:

5.0.0

toXmlString

public String toXmlString()
                   throws GeneratorException

Specified by:

toXmlString in interface BomXmlGenerator

Throws:

GeneratorException