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 class Component.Scope

static class Component.Type

Field Summary

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

Constructor Summary

Constructors
Constructor Description

Component()

Method Summary

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

bomRef
```
private java.lang.String bomRef
```

mimeType
```
private java.lang.String mimeType
```

type
```
private Component.Type type
```

supplier
```
private OrganizationalEntity supplier
```

author

@Deprecated
private java.lang.String author

Deprecated.

publisher
```
private java.lang.String publisher
```

group
```
private java.lang.String group
```

name
```
private java.lang.String name
```

version
```
private java.lang.String version
```

description
```
private java.lang.String description
```

scope
```
private Component.Scope scope
```

hashes
```
private java.util.List<Hash> hashes
```

licenses
```
private LicenseChoice licenses
```

copyright
```
private java.lang.String copyright
```

cpe
```
private java.lang.String cpe
```

purl
```
private java.lang.String purl
```

omniborId

private java.util.List<java.lang.String> omniborId

swhid

private java.util.List<java.lang.String> swhid

swid
```
private Swid swid
```

modified
```
private java.lang.Boolean modified
```

pedigree
```
private Pedigree pedigree
```

externalReferences

private java.util.List<ExternalReference> externalReferences

properties

private java.util.List<Property> properties

components

private java.util.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 java.util.List<java.lang.String> provides

tags
```
private Tags tags
```

authors

private java.util.List<OrganizationalContact> authors

manufacturer

private OrganizationalEntity manufacturer

signature
```
private Signature signature
```

Constructor Detail
- Component
```
public Component()
```

Method Detail

getBomRef
```
public java.lang.String getBomRef()
```

setBomRef

public void setBomRef(java.lang.String bomRef)

getMimeType
```
public java.lang.String getMimeType()
```

setMimeType

public void setMimeType(java.lang.String mimeType)

getSupplier

public OrganizationalEntity getSupplier()

setSupplier

public void setSupplier(OrganizationalEntity supplier)

getAuthor
```
public java.lang.String getAuthor()
```

setAuthor

public void setAuthor(java.lang.String author)

getPublisher

public java.lang.String getPublisher()

setPublisher

public void setPublisher(java.lang.String publisher)

getGroup
```
public java.lang.String getGroup()
```

setGroup

public void setGroup(java.lang.String group)

getName
```
public java.lang.String getName()
```

setName

public void setName(java.lang.String name)

getVersion
```
public java.lang.String getVersion()
```

setVersion

public void setVersion(java.lang.String version)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getScope
```
public Component.Scope getScope()
```

setScope

public void setScope(Component.Scope scope)

getHashes

public java.util.List<Hash> getHashes()

setHashes

public void setHashes(java.util.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 java.lang.String getCopyright()

setCopyright

public void setCopyright(java.lang.String copyright)

getCpe
```
public java.lang.String getCpe()
```
Returns:

the Common Platform Enumeration of the component

setCpe
```
public void setCpe(java.lang.String cpe)
```
Parameters:

cpe - a valid CPE 2.2 or CPE 2.3 string

getPurl
```
public java.lang.String getPurl()
```

setPurl

public void setPurl(java.lang.String purl)

setPurl

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

getSwid
```
public Swid getSwid()
```

setSwid
```
public void setSwid(Swid swid)
```

getModified

public java.lang.Boolean getModified()

isModified
```
public java.lang.Boolean isModified()
```

setModified

public void setModified(java.lang.Boolean modified)

getPedigree
```
public Pedigree getPedigree()
```

setPedigree

public void setPedigree(Pedigree pedigree)

getExternalReferences

public java.util.List<ExternalReference> getExternalReferences()

addExternalReference

public void addExternalReference(ExternalReference externalReference)

setExternalReferences

public void setExternalReferences(java.util.List<ExternalReference> externalReferences)

getProperties

public java.util.List<Property> getProperties()

setProperties

public void setProperties(java.util.List<Property> properties)

addProperty

public void addProperty(Property property)

getComponents

public java.util.List<Component> getComponents()

setComponents

public void setComponents(java.util.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 java.util.List<java.lang.String> getOmniborId()

setOmniborId

public void setOmniborId(java.util.List<java.lang.String> omniborId)

getSwhid

public java.util.List<java.lang.String> getSwhid()

setSwhid

public void setSwhid(java.util.List<java.lang.String> swhid)

getCryptoProperties

public CryptoProperties getCryptoProperties()

setCryptoProperties

public void setCryptoProperties(CryptoProperties cryptoProperties)

getProvides

public java.util.List<java.lang.String> getProvides()

setProvides

public void setProvides(java.util.List<java.lang.String> provides)

getTags
```
public Tags getTags()
```

setTags
```
public void setTags(Tags tags)
```

getAuthors

public java.util.List<OrganizationalContact> getAuthors()

setAuthors

public void setAuthors(java.util.List<OrganizationalContact> authors)

getManufacturer

public OrganizationalEntity getManufacturer()

setManufacturer

public void setManufacturer(OrganizationalEntity manufacturer)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:: equals in class java.lang.Object

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

Class Component

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.cyclonedx.model.ExtensibleElement

Methods inherited from class java.lang.Object

Field Detail

bomRef

mimeType

type

supplier

author

publisher

group

name

version

description

scope

hashes

licenses

copyright

cpe

purl

omniborId

swhid

swid

modified

pedigree

externalReferences

properties

components

evidence

releaseNotes

modelCard

data

cryptoProperties

provides

tags

authors

manufacturer

signature

Constructor Detail

Component

Method Detail

getBomRef

setBomRef

getMimeType

setMimeType

getSupplier

setSupplier

getAuthor

setAuthor

getPublisher

setPublisher

getGroup

setGroup

getName

setName

getVersion

setVersion

getDescription

setDescription

getScope

setScope

getHashes

setHashes

addHash

getLicenses

setLicenses

getLicenseChoice

setLicenseChoice

getCopyright

setCopyright

getCpe

setCpe

getPurl

setPurl

setPurl

getSwid