org.cyclonedx.model

Class Bom

java.lang.Object

org.cyclonedx.model.ExtensibleElement

org.cyclonedx.model.Bom

public class Bom
extends ExtensibleElement

Constructor Summary

Constructors

Constructor and Description
Bom()

Method Summary

Modifier and Type	Method and Description
void	addComponent(Component component)
void	addDependency(Dependency dependency)
void	addExternalReference(ExternalReference externalReference)
void	addProperty(Property property)
void	addService(Service service)
boolean	equals(Object o)
List<Annotation>	getAnnotations()
String	getBomFormat()
List<Component>	getComponents()
List<Composition>	getCompositions()
Declarations	getDeclarations()
Definition	getDefinitions()
List<Dependency>	getDependencies()
List<ExternalReference>	getExternalReferences()
List<Formula>	getFormulation()
Metadata	getMetadata()
List<Property>	getProperties()
String	getSerialNumber()
List<Service>	getServices()
Signature	getSignature()
String	getSpecVersion() Returns the CycloneDX spec version of a Bom.
int	getVersion()
List<Vulnerability>	getVulnerabilities()
String	getXmlns()
int	hashCode()
void	setAnnotations(List<Annotation> annotations)
void	setComponents(List<Component> components)
void	setCompositions(List<Composition> compositions)
void	setDeclarations(Declarations declarations)
void	setDefinitions(Definition definitions)
void	setDependencies(List<Dependency> dependencies)
void	setExternalReferences(List<ExternalReference> externalReferences)
void	setFormulation(List<Formula> formulation)
void	setMetadata(Metadata metadata)
void	setProperties(List<Property> properties)
void	setSerialNumber(String serialNumber)
void	setServices(List<Service> services)
void	setSignature(Signature signature)
void	setVersion(int version)
void	setVulnerabilities(List<Vulnerability> vulnerabilities)
void	setXmlns(String xmlns)

Methods inherited from class org.cyclonedx.model.ExtensibleElement

add, addExtensibleType, getExtensibleTypes, getExtensions, setExtensibleTypes, setExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

Bom

public Bom()

Method Detail

getMetadata

public Metadata getMetadata()

setMetadata

public void setMetadata(Metadata metadata)

getComponents

public List<Component> getComponents()

setComponents

public void setComponents(List<Component> components)

addComponent

public void addComponent(Component component)

getServices

public List<Service> getServices()

setServices

public void setServices(List<Service> services)

addService

public void addService(Service service)

getDependencies

public List<Dependency> getDependencies()

setDependencies

public void setDependencies(List<Dependency> dependencies)

addDependency

public void addDependency(Dependency dependency)

getExternalReferences

public List<ExternalReference> getExternalReferences()

addExternalReference

public void addExternalReference(ExternalReference externalReference)

setExternalReferences

public void setExternalReferences(List<ExternalReference> externalReferences)

getCompositions

public List<Composition> getCompositions()

setCompositions

public void setCompositions(List<Composition> compositions)

getFormulation

public List<Formula> getFormulation()

setFormulation

public void setFormulation(List<Formula> formulation)

getVulnerabilities

public List<Vulnerability> getVulnerabilities()

setVulnerabilities

public void setVulnerabilities(List<Vulnerability> vulnerabilities)

getAnnotations

public List<Annotation> getAnnotations()

setAnnotations

public void setAnnotations(List<Annotation> annotations)

getProperties

public List<Property> getProperties()

setProperties

public void setProperties(List<Property> properties)

addProperty

public void addProperty(Property property)

getDeclarations

public Declarations getDeclarations()

setDeclarations

public void setDeclarations(Declarations declarations)

getDefinitions

public Definition getDefinitions()

setDefinitions

public void setDefinitions(Definition definitions)

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

getSerialNumber

public String getSerialNumber()

setSerialNumber

public void setSerialNumber(String serialNumber)

getXmlns

public String getXmlns()

setXmlns

public void setXmlns(String xmlns)

getSpecVersion

public String getSpecVersion()

Returns the CycloneDX spec version of a Bom. The spec version will only be populated when paring a bom via Parser. It has no affect on bom generation or any other functionality.

Returns:

the String version representation of the spec version

getBomFormat

public String getBomFormat()

getSignature

public Signature getSignature()

setSignature

public void setSignature(Signature signature)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object