Package org.apache.ant.cyclonedx

Class Organization

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class Organization
extends org.apache.tools.ant.types.DataType
    Organization appears as "manufacturer" or "supplier" of components or the SBOM itself.

    The CycloneDX specification supports more information for an organization than this type currently exposes.

    This class is a type exposed by this Ant Library. When using the inherited refid attribute it can reference an instance defined previously - in which case no child elements or other attributes are allowed.

    • Field Summary

      • Fields inherited from class org.apache.tools.ant.types.DataType

        checked, ref

      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        description, location, project

    • Constructor Summary

      Constructors 
      Constructor Description
      Organization()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addConfiguredUrl​(org.apache.tools.ant.types.resources.URLResource url)
      Adds an url of the organization.
      protected Organization getRef()
      Perform the check for circular references and return the referenced Organization.
      void setName​(java.lang.String name)
      Sets the name of the organization.
      org.cyclonedx.model.OrganizationalEntity toOrganizationalEntity()
      Translates this organisation to its CycloneDX counterpart.

      • Methods inherited from class org.apache.tools.ant.types.DataType

        checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString

      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Organization

        public Organization()

    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the organization.
        Parameters:
        name - organization name

      • addConfiguredUrl

        public void addConfiguredUrl​(org.apache.tools.ant.types.resources.URLResource url)
        Adds an url of the organization.
        Parameters:
        url - organization URI

      • toOrganizationalEntity

        public org.cyclonedx.model.OrganizationalEntity toOrganizationalEntity()
        Translates this organisation to its CycloneDX counterpart.
        Returns:
        the CycloneDX version of this instance.

      • getRef

        protected Organization getRef()
        Perform the check for circular references and return the referenced Organization.
        Returns:
        Organization.