Class Component

java.lang.Object
org.cyclonedx.model.ExtensibleElement
org.cyclonedx.model.Component
public class Component extends ExtensibleElement

  • 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

      @Deprecated public String getAuthor()
      Deprecated.
      since version 1.6, use getAuthors() instead
      Gets the deprecated author field as a string.
      Returns:
      the author name as a string

    • setAuthor

      @Deprecated public void setAuthor(String author)
      Deprecated.
      since version 1.6, use setAuthors(List) instead
      Sets the deprecated author field as a string.
      Parameters:
      author - the author name as a string

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

    • getVersionRange

      public String getVersionRange()

    • setVersionRange

      public void setVersionRange(String versionRange)

    • getIsExternal

      public Boolean getIsExternal()

    • setIsExternal

      public void setIsExternal(Boolean isExternal)

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

    • getPatentAssertions

      public List<PatentAssertion> getPatentAssertions()

    • setPatentAssertions

      public void setPatentAssertions(List<PatentAssertion> patentAssertions)

    • getTags

      public Tags getTags()

    • setTags

      public void setTags(Tags tags)

    • getAuthors

      public List<OrganizationalContact> getAuthors()
      Gets the component authors as a list of contacts. This replaces the deprecated string-based author field.
      Returns:
      the list of authors, or null if not set
      Since:
      1.6

    • setAuthors

      public void setAuthors(List<OrganizationalContact> authors)
      Sets the component authors as a list of contacts. This replaces the deprecated string-based author field.
      Parameters:
      authors - the list of authors
      Since:
      1.6

    • getManufacturer

      public OrganizationalEntity getManufacturer()

    • setManufacturer

      public void setManufacturer(OrganizationalEntity manufacturer)

    • validate

      public void validate()
      Validates that the component conforms to CycloneDX 1.7 choice group constraints. Specifically: - version and versionRange are mutually exclusive (xs:choice group) - versionRange should have isExternal=true
      Throws:
      IllegalStateException - if validation fails

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object