org.cyclonedx.generators.json

Class BomJsonGenerator13

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.json.AbstractBomJsonGenerator

org.cyclonedx.generators.json.BomJsonGenerator13

All Implemented Interfaces:

BomJsonGenerator

public class BomJsonGenerator13
extends AbstractBomJsonGenerator
implements BomJsonGenerator

BomGenerator creates a CycloneDX bill-of-material document from a set of Components.

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.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
BomJsonGenerator13(Bom bom) Constructs a new BomGenerator object.

Method Summary

Modifier and Type	Method and Description
CycloneDxSchema.Version	getSchemaVersion() Returns the version of the CycloneDX schema used by this instance
javax.json.JsonObject	toJsonObject() Creates a CycloneDX BOM from a set of Components.
String	toJsonString()
String	toString()

Methods inherited from class org.cyclonedx.generators.json.AbstractBomJsonGenerator

getMapper

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

Constructor Detail

BomJsonGenerator13

public BomJsonGenerator13(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 BomJsonGenerator

Returns:

a CycloneDxSchemaVersion enum

toJsonObject

public javax.json.JsonObject toJsonObject()

Creates a CycloneDX BOM from a set of Components.

Specified by:

toJsonObject in interface BomJsonGenerator

Returns:

an JSON Document representing a CycloneDX BoM

Since:

5.0.0

toJsonString

public String toJsonString()

Specified by:

toJsonString in interface BomJsonGenerator

toString

public String toString()

Specified by:

toString in interface BomJsonGenerator

Overrides:

toString in class Object