org.cyclonedx.model

Class Component

java.lang.Object

org.cyclonedx.model.ExtensibleElement

org.cyclonedx.model.Component

public class Component
extends ExtensibleElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Component.Scope
static class	Component.Type

Constructor Summary

Constructors

Constructor and Description
Component()

Method Summary

Modifier and Type	Method and Description
void	addComponent(Component component)
void	addExternalReference(ExternalReference externalReference)
void	addHash(Hash hash)
boolean	equals(Object o)
String	getAuthor()
String	getBomRef()
List<Component>	getComponents()
String	getCopyright()
String	getCpe() Deprecated. CPE will be removed in a future version of the CycloneDX specification.
String	getDescription()
Evidence	getEvidence()
List<ExternalReference>	getExternalReferences()
String	getGroup()
List<Hash>	getHashes()
LicenseChoice	getLicenseChoice()
String	getMimeType()
Boolean	getModified()
String	getName()
Pedigree	getPedigree()
List<Property>	getProperties()
String	getPublisher()
String	getPurl()
Component.Scope	getScope()
OrganizationalEntity	getSupplier()
Swid	getSwid()
Component.Type	getType()
String	getVersion()
int	hashCode()
Boolean	isModified()
void	setAuthor(String author)
void	setBomRef(String bomRef)
void	setComponents(List<Component> components)
void	setCopyright(String copyright)
void	setCpe(String cpe) Deprecated. CPE will be removed in a future version of the CycloneDX specification.
void	setDescription(String description)
void	setEvidence(Evidence evidence)
void	setExternalReferences(List<ExternalReference> externalReferences)
void	setGroup(String group)
void	setHashes(List<Hash> hashes)
void	setLicenseChoice(LicenseChoice licenseChoice)
void	setMimeType(String mimeType)
void	setModified(Boolean modified)
void	setName(String name)
void	setPedigree(Pedigree pedigree)
void	setProperties(List<Property> properties)
void	setPublisher(String publisher)
void	setPurl(com.github.packageurl.PackageURL purl)
void	setPurl(String purl)
void	setScope(Component.Scope scope)
void	setSupplier(OrganizationalEntity supplier)
void	setSwid(Swid swid)
void	setType(Component.Type type)
void	setVersion(String version)

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

Component

public Component()

Method Detail

getBomRef

public String getBomRef()

setBomRef

public void setBomRef(String bomRef)

getMimeType

public String getMimeType()

setMimeType

public void setMimeType(String mimeType)

getSupplier

public OrganizationalEntity getSupplier()

setSupplier

public void setSupplier(OrganizationalEntity supplier)

getAuthor

public String getAuthor()

setAuthor

public void setAuthor(String author)

getPublisher

public String getPublisher()

setPublisher

public void setPublisher(String publisher)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)

getName

public String getName()

setName

public void setName(String name)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getScope

public Component.Scope getScope()

setScope

public void setScope(Component.Scope scope)

getHashes

public List<Hash> getHashes()

setHashes

public void setHashes(List<Hash> hashes)

addHash

public void addHash(Hash hash)

getLicenseChoice

public LicenseChoice getLicenseChoice()

setLicenseChoice

public void setLicenseChoice(LicenseChoice licenseChoice)

getCopyright

public String getCopyright()

setCopyright

public void setCopyright(String copyright)

getCpe

@Deprecated
public String getCpe()

Deprecated. CPE will be removed in a future version of the CycloneDX specification.

Returns:

the Common Platform Enumeration of the component

setCpe

@Deprecated
public void setCpe(String cpe)

Deprecated. CPE will be removed in a future version of the CycloneDX specification.

Parameters:

cpe - a valid CPE 2.2 or CPE 2.3 string

getPurl

public String getPurl()

setPurl

public void setPurl(String purl)

setPurl

public void setPurl(com.github.packageurl.PackageURL purl)

getSwid

public Swid getSwid()

setSwid

public void setSwid(Swid swid)

getModified

public Boolean getModified()

isModified

public Boolean isModified()

setModified

public void setModified(Boolean modified)

getPedigree

public Pedigree getPedigree()

setPedigree

public void setPedigree(Pedigree pedigree)

getExternalReferences

public List<ExternalReference> getExternalReferences()

addExternalReference

public void addExternalReference(ExternalReference externalReference)

setExternalReferences

public void setExternalReferences(List<ExternalReference> externalReferences)

getProperties

public List<Property> getProperties()

setProperties

public void setProperties(List<Property> properties)

getComponents

public List<Component> getComponents()

setComponents

public void setComponents(List<Component> components)

addComponent

public void addComponent(Component component)

getEvidence

public Evidence getEvidence()

setEvidence

public void setEvidence(Evidence evidence)

getType

public Component.Type getType()

setType

public void setType(Component.Type type)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object