org.cyclonedx.generators.xml

Class AbstractBomXmlGenerator

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.xml.AbstractBomXmlGenerator

All Implemented Interfaces:

BomXmlGenerator

Direct Known Subclasses:

BomXmlGenerator10, BomXmlGenerator11, BomXmlGenerator12, BomXmlGenerator13

public abstract class AbstractBomXmlGenerator
extends CycloneDxSchema
implements BomXmlGenerator

Nested Class Summary

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

CycloneDxSchema.Version

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PROLOG

Fields inherited from class org.cyclonedx.CycloneDxSchema

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

Constructor Summary

Constructors

Constructor and Description
AbstractBomXmlGenerator()

Method Summary

Modifier and Type	Method and Description
DocumentBuilder	buildSecureDocumentBuilder() Constructs a new document builder with security features enabled.
protected Document	generateDocument(Bom bom)
com.fasterxml.jackson.databind.ObjectMapper	getMapper()
String	toString() Creates a text representation of a CycloneDX BoM Document.

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

generate, getSchemaVersion, toXmlString

Field Detail

PROLOG

protected static final String PROLOG

See Also:

Constant Field Values

Constructor Detail

AbstractBomXmlGenerator

public AbstractBomXmlGenerator()

Method Detail

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

buildSecureDocumentBuilder

public DocumentBuilder buildSecureDocumentBuilder()
                                           throws ParserConfigurationException

Constructs a new document builder with security features enabled.

Returns:

a new document builder

Throws:

ParserConfigurationException - thrown if there is a parser configuration exception

generateDocument

protected Document generateDocument(Bom bom)
                             throws ParserConfigurationException

Throws:

ParserConfigurationException

toString

public String toString()

Creates a text representation of a CycloneDX BoM Document. This method calls BomXmlGenerator.toXmlString() and will return an empty string if BomXmlGenerator.toXmlString() throws an exception. Its preferred to call BomXmlGenerator.toXmlString() directly so that exceptions can be caught.

Specified by:

toString in interface BomXmlGenerator

Overrides:

toString in class Object

Returns:

a String of the BoM

Since:

1.1.0