Package org.cyclonedx.generators.json

Class BomJsonGenerator

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.AbstractBomGenerator

org.cyclonedx.generators.json.BomJsonGenerator

public class BomJsonGenerator
extends AbstractBomGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private com.fasterxml.jackson.core.util.DefaultPrettyPrinter	prettyPrinter

Fields inherited from class org.cyclonedx.generators.AbstractBomGenerator

bom, format, mapper, 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
BomJsonGenerator(Bom bom, Version version)	Constructs a new BomGenerator object.

Method Summary

Modifier and Type	Method	Description
private Bom	injectBomFormatAndSpecVersion(Bom bom)
private void	setupObjectMapper()
private void	setupPrettyPrinter(com.fasterxml.jackson.core.util.DefaultPrettyPrinter prettyPrinter)
(package private) java.lang.String	toJson(Bom bom, boolean prettyPrint)
com.fasterxml.jackson.databind.JsonNode	toJsonNode()	Creates a CycloneDX BOM from a set of Components.
java.lang.String	toJsonString()
java.lang.String	toString()	Creates a text representation of a CycloneDX BoM Document.

Methods inherited from class org.cyclonedx.generators.AbstractBomGenerator

getFormat, getSchemaVersion, setupObjectMapper

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

Field Detail

prettyPrinter

private final com.fasterxml.jackson.core.util.DefaultPrettyPrinter prettyPrinter

Constructor Detail

BomJsonGenerator

public BomJsonGenerator(Bom bom,
                        Version version)

Constructs a new BomGenerator object.

Parameters:

bom - the BOM to generate

version - the version of the CycloneDX schema to use.

Method Detail

setupObjectMapper

private void setupObjectMapper()

setupPrettyPrinter

private void setupPrettyPrinter(com.fasterxml.jackson.core.util.DefaultPrettyPrinter prettyPrinter)

injectBomFormatAndSpecVersion

private Bom injectBomFormatAndSpecVersion(Bom bom)
                                   throws GeneratorException

Throws:

GeneratorException

toJsonNode

public com.fasterxml.jackson.databind.JsonNode toJsonNode()

Creates a CycloneDX BOM from a set of Components.

Returns:

an JSON Document representing a CycloneDX BoM

Since:

7.0.0

toJsonString

public java.lang.String toJsonString()
                              throws GeneratorException

Throws:

GeneratorException

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

a String of the BoM

toJson

java.lang.String toJson(Bom bom,
                        boolean prettyPrint)
                 throws GeneratorException

Throws:

GeneratorException