Index (ant-cyclonedx API)

A C D E F G H I J L O P R S T V
All Classes All Packages

A

add(ComponentResolver) - Method in class org.apache.ant.cyclonedx.Component: Resolver that uses external data to enrich this component.
add(Resource) - Method in class org.apache.ant.cyclonedx.Component: Sets the resource the component is about.
add(ResourceCollection) - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection: Adds the resources to map.
add(FileNameMapper) - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection: Creates a nested mapper by directly providing the implementation.
addAdditionalComponent(Component) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Adds another component to the SBOM.
addAuthor(OrganizationalContact) - Method in class org.apache.ant.cyclonedx.Component: Adds an author to the component.
addComponent(Component) - Method in class org.apache.ant.cyclonedx.Component: Adds a nested component.
addConfiguredExternalReference(ExternalReference) - Method in class org.apache.ant.cyclonedx.Component: Adds an external reference to the component.
addConfiguredExternalReference(ExternalReference) - Method in class org.apache.ant.cyclonedx.ExternalReferenceSet: Adds an external reference to this set.
addConfiguredExternalReferenceSet(ExternalReferenceSet) - Method in class org.apache.ant.cyclonedx.Component: Adds a set of external references to the component.
addConfiguredLicense(License) - Method in class org.apache.ant.cyclonedx.Component: Adds a license to this component.
addConfiguredLicense(License) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Adds a license to the SBOM's metadata.
addConfiguredProperty(Property) - Method in class org.apache.ant.cyclonedx.Component: Adds a property to the component.
addConfiguredProperty(Property) - Method in class org.apache.ant.cyclonedx.PropertySet: Adds a property to the set.
addConfiguredPropertySet(PropertySet) - Method in class org.apache.ant.cyclonedx.Component: Adds a set of properties to the component.
addConfiguredTag(Component.Tag) - Method in class org.apache.ant.cyclonedx.Component: Adds a tag to the component.
addConfiguredTemplateComponent(Component) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Adds a nested template component.
addConfiguredUrl(URLResource) - Method in class org.apache.ant.cyclonedx.License: Sets the url of the license.
addConfiguredUrl(URLResource) - Method in class org.apache.ant.cyclonedx.Organization: Adds an url of the organization.
addDependency(Component.Dependency) - Method in class org.apache.ant.cyclonedx.Component: Adds a dependency to this component.
addHashes(Component, Version) - Method in class org.apache.ant.cyclonedx.Component: If this component has a nested resource child, all hashes supported by the CycloneDX Core library for the spec version are created and added to the given component.
addManufacturer(Organization) - Method in class org.apache.ant.cyclonedx.Component: Sets the manufacturer of the component.
addSupplier(Organization) - Method in class org.apache.ant.cyclonedx.Component: Sets the supplier of the component.
addText(String) - Method in class org.apache.ant.cyclonedx.Component.Tag: Sets the tag value.
addToolComponent(Component) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Adds component to be added to the metadata.tools section of the SBOM.
areDependenciesUnknown() - Method in class org.apache.ant.cyclonedx.Component: Whether dependencies are unknoown.

C

Component - Class in org.apache.ant.cyclonedx: The central concept of an SBOM which describes components and their dependencies.
Component() - Constructor for class org.apache.ant.cyclonedx.Component: Default constructor.
Component(Component) - Constructor for class org.apache.ant.cyclonedx.Component: Copy constructor creating a shallow copy.
Component.Dependency - Class in org.apache.ant.cyclonedx: Represents a dependency of a component.
Component.Tag - Class in org.apache.ant.cyclonedx: Represents a tag.
ComponentBomTask - Class in org.apache.ant.cyclonedx: Task that creates CycloneDX BOMs for a single component.
ComponentBomTask() - Constructor for class org.apache.ant.cyclonedx.ComponentBomTask
ComponentComparator - Static variable in class org.apache.ant.cyclonedx.Component: Comparator for components.
ComponentResolver - Interface in org.apache.ant.cyclonedx: Common interface for "resolvers" that read data of a component form external sources and enrich an existing component withe data read - and may even identify additional components.
ComponentScope - Class in org.apache.ant.cyclonedx: CycloneDX component type.
ComponentScope() - Constructor for class org.apache.ant.cyclonedx.ComponentScope
ComponentType - Class in org.apache.ant.cyclonedx: CycloneDX component type.
ComponentType() - Constructor for class org.apache.ant.cyclonedx.ComponentType
CompositionAggregate - Class in org.apache.ant.cyclonedx: CycloneDX composition's aggregate type.
CompositionAggregate() - Constructor for class org.apache.ant.cyclonedx.CompositionAggregate
createComponent() - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Sets the component for the SBOM.
createFileComponent(Project, Resource) - Static method in class org.apache.ant.cyclonedx.Component: Creates a new "file" type component for a resource.
createManufacturer() - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Sets the manufacturer of the SBOM.
createMapper() - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection: Creates a nested mapper.
createPureFileComponents() - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Accepts arbitrary file-system only resources that will be added as components of type file.
createSupplier() - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Sets the supplier of the SBOM.
CycloneDxComponentComparator - Static variable in class org.apache.ant.cyclonedx.Component: Comparator for CycloneDX components.
CycloneDxExternalReferenceComparator - Static variable in class org.apache.ant.cyclonedx.ExternalReference: Comparator for CycloneDX external references.
CycloneDxLicenseItemComparator - Static variable in class org.apache.ant.cyclonedx.License: Comparator for CycloneDX License Items.

D

DEFAULT - Static variable in class org.apache.ant.cyclonedx.SpecVersion: Default spec version.
Dependency() - Constructor for class org.apache.ant.cyclonedx.Component.Dependency
DependencyComparator - Static variable in class org.apache.ant.cyclonedx.Component.Dependency: Comparator for dependencies.
dieOnCircularReference(Stack<Object>, Project) - Method in class org.apache.ant.cyclonedx.Component

E

EnumUtils - Class in org.apache.ant.cyclonedx: Helpers for the EnumeratedAttributes wrapping enums in this package.
EnumUtils() - Constructor for class org.apache.ant.cyclonedx.EnumUtils
equals(Object) - Method in class org.apache.ant.cyclonedx.SpecVersion
execute() - Method in class org.apache.ant.cyclonedx.ComponentBomTask
ExternalReference - Class in org.apache.ant.cyclonedx: An "external reference", i.e.
ExternalReference() - Constructor for class org.apache.ant.cyclonedx.ExternalReference
ExternalReferenceSet - Class in org.apache.ant.cyclonedx: A container for a collection of ExternalReferences.
ExternalReferenceSet() - Constructor for class org.apache.ant.cyclonedx.ExternalReferenceSet

F

FilesystemOnlyMappedResourceCollection - Class in org.apache.ant.cyclonedx: A variant of MappedResourceCollection that only accepts file-system resource collections as children and which returns resources that provide access to the underlying files (unlike MappedResourceCollection which prevents direct access.
FilesystemOnlyMappedResourceCollection() - Constructor for class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection
fillFrom(Component, List<Dependency>) - Method in class org.apache.ant.cyclonedx.Component: Enriches this instance with data read from a CycloneDX component and its dependencies.
from(Component.Scope) - Static method in class org.apache.ant.cyclonedx.ComponentScope: Maps a CycloneDX scope.
from(Component.Type) - Static method in class org.apache.ant.cyclonedx.ComponentType: Maps a CycloneDX type.
from(Component, List<Dependency>) - Static method in class org.apache.ant.cyclonedx.Component: Maps from a CycloneDX Component to an incstance of this type.
from(Composition.Aggregate) - Static method in class org.apache.ant.cyclonedx.CompositionAggregate: Maps a CycloneDX Aggregate.
from(LicenseItem) - Static method in class org.apache.ant.cyclonedx.License: Creates an instance of the License class based on a CylconeDX LicenseItem.

G

getAggregate() - Method in class org.apache.ant.cyclonedx.CompositionAggregate: Translates this instance to a Composition.Aggregate.
getAuthors() - Method in class org.apache.ant.cyclonedx.Component: Gets the authors of the component.
getBomRef() - Method in class org.apache.ant.cyclonedx.Component.Dependency: Looks up the bom-ref of the dependency.
getBomRef() - Method in class org.apache.ant.cyclonedx.Component: Gets the bom-ref of the component.
getComponentFile() - Method in class org.apache.ant.cyclonedx.Component: Gets the resource the component is about.
getCompositionAggregate() - Method in class org.apache.ant.cyclonedx.Component: Gets the composition aggregate of the component.
getCopyright() - Method in class org.apache.ant.cyclonedx.Component: Gets the copyright of the component.
getCycloneDxFormats(Version) - Method in class org.apache.ant.cyclonedx.OutputFormat: Translates this instance to Formats.
getDependencies() - Method in class org.apache.ant.cyclonedx.Component: Gets the dependencies of the component.
getDescription() - Method in class org.apache.ant.cyclonedx.Component: Gets the decription of the component.
getExternalReferences() - Method in class org.apache.ant.cyclonedx.Component: Gets the merged external references added via {@see #addConfiguredExternalReference} or {@see #addConfiguredExternalReferenceSet} to the component.
getExternalReferences() - Method in class org.apache.ant.cyclonedx.ExternalReferenceSet: Return the external references contained in this set.
getGroup() - Method in class org.apache.ant.cyclonedx.Component: Gets the group of the component.
getIsExternal() - Method in class org.apache.ant.cyclonedx.Component: Gets whether the isExternal flag is true.
getLicenses() - Method in class org.apache.ant.cyclonedx.Component: Gets licenses added to this component.
getManufacturer() - Method in class org.apache.ant.cyclonedx.Component: Gets the manufacturer of the component.
getMimeType() - Method in class org.apache.ant.cyclonedx.Component: Gets the mime-type of the component.
getName() - Method in class org.apache.ant.cyclonedx.Component: Gets the name of the component.
getNestedComponents() - Method in class org.apache.ant.cyclonedx.Component: Recursively returns the nested components of this component.
getProperties() - Method in class org.apache.ant.cyclonedx.Component: Gets merged properties added via Component.addConfiguredProperty(org.cyclonedx.model.Property) or Component.addConfiguredPropertySet(org.apache.ant.cyclonedx.PropertySet) to the component.
getProperties() - Method in class org.apache.ant.cyclonedx.PropertySet: Return the external references contained in this set.
getPublisher() - Method in class org.apache.ant.cyclonedx.Component: Gets the publisher of the component.
getPurl() - Method in class org.apache.ant.cyclonedx.Component: Gets the Package-URL (purl) of the component.
getRef() - Method in class org.apache.ant.cyclonedx.Component: Perform the check for circular references and return the referenced Component.
getRef() - Method in class org.apache.ant.cyclonedx.ExternalReferenceSet: Perform the check for circular references and return the referenced ExternalReferenceSet.
getRef() - Method in class org.apache.ant.cyclonedx.License: Perform the check for circular references and return the referenced License.
getRef() - Method in class org.apache.ant.cyclonedx.Organization: Perform the check for circular references and return the referenced Organization.
getRef() - Method in class org.apache.ant.cyclonedx.PropertySet: Perform the check for circular references and return the referenced PropertySet.
getScope() - Method in class org.apache.ant.cyclonedx.Component: Gets the scope of this component.
getScope() - Method in class org.apache.ant.cyclonedx.ComponentScope: Translates this instance to a Component.Scope.
getSupplier() - Method in class org.apache.ant.cyclonedx.Component: Gets the supplier of the component.
getSupplierIsManufacturer() - Method in class org.apache.ant.cyclonedx.Component: Gets whether the supplier shall also be used to provide the manufacturer information.
getTag() - Method in class org.apache.ant.cyclonedx.Component.Tag: Obtains the tag.
getTags() - Method in class org.apache.ant.cyclonedx.Component: Gets the tags of the component.
getType() - Method in class org.apache.ant.cyclonedx.Component: Gets the component type.
getType() - Method in class org.apache.ant.cyclonedx.ComponentType: Translates this instance to a Component.Type.
getValues() - Method in class org.apache.ant.cyclonedx.ComponentScope
getValues() - Method in class org.apache.ant.cyclonedx.ComponentType
getValues() - Method in class org.apache.ant.cyclonedx.CompositionAggregate
getValues() - Method in class org.apache.ant.cyclonedx.OutputFormat
getValues() - Method in class org.apache.ant.cyclonedx.SpecVersion
getVersion() - Method in class org.apache.ant.cyclonedx.Component: Gets the version of the component.
getVersion() - Method in class org.apache.ant.cyclonedx.SpecVersion: Translates this instance to a Version.

H

hashCode() - Method in class org.apache.ant.cyclonedx.SpecVersion

I

isFilesystemOnly() - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection
iterator() - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection
IvyModuleComponentResolver - Class in org.apache.ant.cyclonedx: Resolver that populates a Component from Ivy module data.
IvyModuleComponentResolver() - Constructor for class org.apache.ant.cyclonedx.IvyModuleComponentResolver

J

JSON - Static variable in class org.apache.ant.cyclonedx.OutputFormat: JSON output format.

L

License - Class in org.apache.ant.cyclonedx: A license element to be attached to a component.
License() - Constructor for class org.apache.ant.cyclonedx.License

O

org.apache.ant.cyclonedx - package org.apache.ant.cyclonedx
Organization - Class in org.apache.ant.cyclonedx: Organization appears as "manufacturer" or "supplier" of components or the SBOM itself.
Organization() - Constructor for class org.apache.ant.cyclonedx.Organization
OutputFormat - Class in org.apache.ant.cyclonedx: CycloneDX format to use for the SBOM.
OutputFormat() - Constructor for class org.apache.ant.cyclonedx.OutputFormat

P

PropertySet - Class in org.apache.ant.cyclonedx: A container for a collection of Propertys.
PropertySet() - Constructor for class org.apache.ant.cyclonedx.PropertySet

R

resolve() - Method in class org.apache.ant.cyclonedx.Component: Read the linked SBOM (if any) and merge its content with the one already defined for this component.
resolve(Component) - Method in interface org.apache.ant.cyclonedx.ComponentResolver: Resolves the external data and enriches the component with it.
resolve(Component) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Resolves the Ivy module and populates the component with its data.
resolve(Component) - Method in class org.apache.ant.cyclonedx.SbomLinkComponentResolver: Configures the given component and only adds dependencies if the component doesn't already know about any dependencies itself.

S

SbomLinkComponentResolver - Class in org.apache.ant.cyclonedx: Reads a linked SBOM and configures the component containing the link.
SbomLinkComponentResolver() - Constructor for class org.apache.ant.cyclonedx.SbomLinkComponentResolver
setBomName(String) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Sets the base name of the generated BOM.
setBomRef(String) - Method in class org.apache.ant.cyclonedx.Component.Dependency: Identifies the dependency by its bom-ref.
setBomRef(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the bom-ref of the component.
setComponentRef(Reference) - Method in class org.apache.ant.cyclonedx.Component.Dependency: Identifies the dependency by its Ant id attribute.
setCompositionAggregate(CompositionAggregate) - Method in class org.apache.ant.cyclonedx.Component: Sets the composition aggregate of this component.
setConf(String) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Sets the configurations to include in the SBOM.
setCopyright(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the copyright of the component.
setCreateBomExternalReference(boolean) - Method in class org.apache.ant.cyclonedx.SbomLinkComponentResolver: Whether to create a bom-Type external reference in the resolved component based on the nested resource's URI.
setDescription(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the decription of the component.
setExpression(String) - Method in class org.apache.ant.cyclonedx.License: Sets the SPDX license expression of the license.
setExternalConf(String) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Marks configurations as external.
setFormat(OutputFormat) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Which serialization format of CycloneDX SBOM to use.
setGroup(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the group of the component.
setIsExternal(boolean) - Method in class org.apache.ant.cyclonedx.Component: Sets whether the component is external.
setLicenseId(String) - Method in class org.apache.ant.cyclonedx.License: Sets the id of the license.
setMimeType(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the mime-type of the component.
setName(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the name of the component.
setName(String) - Method in class org.apache.ant.cyclonedx.License: Sets the name of the license.
setName(String) - Method in class org.apache.ant.cyclonedx.Organization: Sets the name of the organization.
setOptionalConf(String) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Marks configurations as optional.
setOutputDirectory(File) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Sets the output directory for the generated SBOM.
setPattern(String) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: The retrieve pattern used for retrieving the dependency artifacts.
setPublisher(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the publisher of the component.
setPurl(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the Package-URL (purl) of the component.
setResolveId(String) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Sets the id which was used for a previous resolve.
setScope(ComponentScope) - Method in class org.apache.ant.cyclonedx.Component: Sets the scope of this component.
setSerialNumber(String) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Specifies the serial number of the BOM.
setSettingsRef(Reference) - Method in class org.apache.ant.cyclonedx.IvyModuleComponentResolver: Sets a reference is a different Ivy settings file than the default shall be used.
setSpecVersion(SpecVersion) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Specifies the CycloneDX version to use.
setSupplierIsManufacturer(boolean) - Method in class org.apache.ant.cyclonedx.Component: If set to true the supplier will also be used to provide the manufacturer information.
setType(String) - Method in class org.apache.ant.cyclonedx.ExternalReference: Set the type of the external reference.
setType(ComponentType) - Method in class org.apache.ant.cyclonedx.Component: Sets the type of the component.
setUnknownDependencies(boolean) - Method in class org.apache.ant.cyclonedx.Component: Sets whether the dependencies of this component are unknown.
setUrl(String) - Method in class org.apache.ant.cyclonedx.ExternalReference: Set the URL (actually URI) of the external reference.
setUseComponentManufacturer(boolean) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Whether to use the manufacturer of the main component as manufacturer for the BOM as well.
setUseComponentSupplier(boolean) - Method in class org.apache.ant.cyclonedx.ComponentBomTask: Whether to use the supplier of the main component as supplier for the BOM as well.
setVersion(String) - Method in class org.apache.ant.cyclonedx.Component: Sets the version of the component.
size() - Method in class org.apache.ant.cyclonedx.FilesystemOnlyMappedResourceCollection
SpecVersion - Class in org.apache.ant.cyclonedx: CycloneDX specification version to use for the SBOM.
SpecVersion() - Constructor for class org.apache.ant.cyclonedx.SpecVersion

T

Tag() - Constructor for class org.apache.ant.cyclonedx.Component.Tag: Creates an empty instance.
Tag(String) - Constructor for class org.apache.ant.cyclonedx.Component.Tag: Creates a new instance.
toAdditionalCycloneDxComponent(Version) - Method in class org.apache.ant.cyclonedx.Component: Translates this component to a CycloneDX component suitable for the components.component.
toCycloneDxComponent(Version) - Method in class org.apache.ant.cyclonedx.Component: Maps all common data except for scope and isExternal.
toCycloneDxExternalReference() - Method in class org.apache.ant.cyclonedx.ExternalReference: Maps the instance to a CycloneDX ExternalReference.
toCycloneDxLicenseItem() - Method in class org.apache.ant.cyclonedx.License: Maps the license to its CycloneDX counterpart.
toMainCycloneDxComponent(Version) - Method in class org.apache.ant.cyclonedx.Component: Translates this component to a CycloneDX component suitable for the metadata.component.
toOrganizationalEntity() - Method in class org.apache.ant.cyclonedx.Organization: Translates this organisation to its CycloneDX counterpart.

V

valueOf(Class<E>, String, Function<E, String>) - Static method in class org.apache.ant.cyclonedx.EnumUtils: Maps a string to an enum value.
valuesPlus(Class<E>, Function<E, String>) - Static method in class org.apache.ant.cyclonedx.EnumUtils: Provides strings that can be mapped to enum values unambiguously.

A C D E F G H I J L O P R S T V
All Classes All Packages