Package 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	Description
static enum	Component.Scope
static enum	Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
private String	author	Deprecated.
private List<OrganizationalContact>	authors
private String	bomRef
private List<Component>	components
private String	copyright
private String	cpe
private CryptoProperties	cryptoProperties
private ComponentData	data
private String	description
private Evidence	evidence
private List<ExternalReference>	externalReferences
private String	group
private List<Hash>	hashes
private LicenseChoice	licenses
private OrganizationalEntity	manufacturer
private String	mimeType
private ModelCard	modelCard
private Boolean	modified
private String	name
private List<String>	omniborId
private Pedigree	pedigree
private List<Property>	properties
private List<String>	provides
private String	publisher
private String	purl
private ReleaseNotes	releaseNotes
private Component.Scope	scope
private Signature	signature
private OrganizationalEntity	supplier
private List<String>	swhid
private Swid	swid
private Tags	tags
private Component.Type	type
private String	version

Constructor Summary

Constructors

Constructor	Description
Component()

Method Summary

Modifier and Type	Method	Description
void	addComponent(Component component)
void	addExternalReference(ExternalReference externalReference)
void	addHash(Hash hash)
void	addProperty(Property property)
boolean	equals(Object o)
String	getAuthor()
List<OrganizationalContact>	getAuthors()
String	getBomRef()
List<Component>	getComponents()
String	getCopyright()
String	getCpe()
CryptoProperties	getCryptoProperties()
ComponentData	getData()
String	getDescription()
Evidence	getEvidence()
List<ExternalReference>	getExternalReferences()
String	getGroup()
List<Hash>	getHashes()
LicenseChoice	getLicenseChoice()	Deprecated.
LicenseChoice	getLicenses()
OrganizationalEntity	getManufacturer()
String	getMimeType()
ModelCard	getModelCard()
Boolean	getModified()
String	getName()
List<String>	getOmniborId()
Pedigree	getPedigree()
List<Property>	getProperties()
List<String>	getProvides()
String	getPublisher()
String	getPurl()
ReleaseNotes	getReleaseNotes()
Component.Scope	getScope()
Signature	getSignature()
OrganizationalEntity	getSupplier()
List<String>	getSwhid()
Swid	getSwid()
Tags	getTags()
Component.Type	getType()
String	getVersion()
int	hashCode()
Boolean	isModified()
void	setAuthor(String author)
void	setAuthors(List<OrganizationalContact> authors)
void	setBomRef(String bomRef)
void	setComponents(List<Component> components)
void	setCopyright(String copyright)
void	setCpe(String cpe)
void	setCryptoProperties(CryptoProperties cryptoProperties)
void	setData(ComponentData data)
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)	Deprecated.
void	setLicenses(LicenseChoice licenses)
void	setManufacturer(OrganizationalEntity manufacturer)
void	setMimeType(String mimeType)
void	setModelCard(ModelCard modelCard)
void	setModified(Boolean modified)
void	setName(String name)
void	setOmniborId(List<String> omniborId)
void	setPedigree(Pedigree pedigree)
void	setProperties(List<Property> properties)
void	setProvides(List<String> provides)
void	setPublisher(String publisher)
void	setPurl(com.github.packageurl.PackageURL purl)
void	setPurl(String purl)
void	setReleaseNotes(ReleaseNotes releaseNotes)
void	setScope(Component.Scope scope)
void	setSignature(Signature signature)
void	setSupplier(OrganizationalEntity supplier)
void	setSwhid(List<String> swhid)
void	setSwid(Swid swid)
void	setTags(Tags tags)
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

Field Details

bomRef

private String bomRef

mimeType

private String mimeType

type

private Component.Type type

supplier

private OrganizationalEntity supplier

author

@Deprecated
private String author

Deprecated.

publisher

private String publisher

group

private String group

name

private String name

version

private String version

description

private String description

scope

private Component.Scope scope

hashes

private List<Hash> hashes

licenses

private LicenseChoice licenses

copyright

private String copyright

cpe

private String cpe

purl

private String purl

omniborId

private List<String> omniborId

swhid

private List<String> swhid

swid

private Swid swid

modified

private Boolean modified

pedigree

private Pedigree pedigree

externalReferences

private List<ExternalReference> externalReferences

properties

private List<Property> properties

components

private List<Component> components

evidence

private Evidence evidence

releaseNotes

private ReleaseNotes releaseNotes

modelCard

private ModelCard modelCard

data

private ComponentData data

cryptoProperties

private CryptoProperties cryptoProperties

provides

private List<String> provides

tags

private Tags tags

authors

private List<OrganizationalContact> authors

manufacturer

private OrganizationalEntity manufacturer

signature

private Signature signature

Constructor Details

Component

public Component()

Method Details

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)

getLicenses

public LicenseChoice getLicenses()

setLicenses

public void setLicenses(LicenseChoice licenses)

getLicenseChoice

@Deprecated
public LicenseChoice getLicenseChoice()

Deprecated.

setLicenseChoice

@Deprecated
public void setLicenseChoice(LicenseChoice licenseChoice)

Deprecated.

getCopyright

public String getCopyright()

setCopyright

public void setCopyright(String copyright)

getCpe

public String getCpe()

Returns:

the Common Platform Enumeration of the component

setCpe

public void setCpe(String cpe)

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)

addProperty

public void addProperty(Property property)

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)

getReleaseNotes

public ReleaseNotes getReleaseNotes()

setReleaseNotes

public void setReleaseNotes(ReleaseNotes releaseNotes)

getSignature

public Signature getSignature()

setSignature

public void setSignature(Signature signature)

getModelCard

public ModelCard getModelCard()

setModelCard

public void setModelCard(ModelCard modelCard)

getData

public ComponentData getData()

setData

public void setData(ComponentData data)

getOmniborId

public List<String> getOmniborId()

setOmniborId

public void setOmniborId(List<String> omniborId)

getSwhid

public List<String> getSwhid()

setSwhid

public void setSwhid(List<String> swhid)

getCryptoProperties

public CryptoProperties getCryptoProperties()

setCryptoProperties

public void setCryptoProperties(CryptoProperties cryptoProperties)

getProvides

public List<String> getProvides()

setProvides

public void setProvides(List<String> provides)

getTags

public Tags getTags()

setTags

public void setTags(Tags tags)

getAuthors

public List<OrganizationalContact> getAuthors()

setAuthors

public void setAuthors(List<OrganizationalContact> authors)

getManufacturer

public OrganizationalEntity getManufacturer()

setManufacturer

public void setManufacturer(OrganizationalEntity manufacturer)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object