Component (CycloneDX Core (Java) 11.0.0-SNAPSHOT API)

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

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

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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()`
`List<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(List<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

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)
```

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 List<ComponentData> getData()
```

setData

public void setData(List<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

Class Component

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.cyclonedx.model.ExtensibleElement

Methods inherited from class java.lang.Object

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

setSwid

getModified

isModified

setModified

getPedigree

setPedigree

getExternalReferences

addExternalReference

setExternalReferences

getProperties

setProperties

addProperty

getComponents

setComponents

addComponent

getEvidence

setEvidence

getType

setType

getReleaseNotes

setReleaseNotes

getSignature

setSignature

getModelCard

setModelCard

getData

setData

getOmniborId

setOmniborId

getSwhid

setSwhid

getCryptoProperties

setCryptoProperties

getProvides

setProvides

getTags