Class Package

Inheritance

System.Object

Package

Namespace: CycloneDX.Spdx.Models.v2_2

Assembly: CycloneDX.Spdx.dll

Syntax

public class Package : object

Properties

Annotations

Provide additional information about an SpdxElement.

Declaration

public List<Annotation> Annotations { get; set; }

Property Value

Type	Description
List<Annotation>

AttributionTexts

This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include theactual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.

Declaration

public List<string> AttributionTexts { get; set; }

Property Value

Type	Description
List<System.String>

Checksums

The checksum property provides a mechanism that can be used to verify that the contents of a File or Package have not changed.

Declaration

public List<Checksum> Checksums { get; set; }

Property Value

Type	Description
List<Checksum>

Comment

Declaration

public string Comment { get; set; }

Property Value

Type	Description
System.String

CopyrightText

The text of copyright declarations recited in the Package or File.

Declaration

public string CopyrightText { get; set; }

Property Value

Type	Description
System.String

Description

Provides a detailed description of the package.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DownloadLocation

The URI at which this package is available for download. Private (i.e., not publicly reachable) URIs are acceptable as values of this property. The values http://spdx.org/rdf/terms#none and http://spdx.org/rdf/terms#noassertion may be used to specify that the package is not downloadable or that no attempt was made to determine its download location, respectively.

Declaration

public string DownloadLocation { get; set; }

Property Value

Type	Description
System.String

ExternalRefs

An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.

Declaration

public List<ExternalRef> ExternalRefs { get; set; }

Property Value

Type	Description
List<ExternalRef>

FilesAnalyzed

Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document. If false indicates packages that represent metadata or URI references to a project, product, artifact, distribution or a component. If set to false, the package must not contain any files.

Declaration

public bool? FilesAnalyzed { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasFiles

Indicates that a particular file belongs to a package.

Declaration

public List<string> HasFiles { get; set; }

Property Value

Type	Description
List<System.String>

Homepage

Declaration

public string Homepage { get; set; }

Property Value

Type	Description
System.String

LicenseComments

The licenseComments property allows the preparer of the SPDX document to describe why the licensing in spdx:licenseConcluded was chosen.

Declaration

public string LicenseComments { get; set; }

Property Value

Type	Description
System.String

LicenseConcluded

License expression for licenseConcluded. The licensing that the preparer of this SPDX document has concluded, based on the evidence, actually applies to the package.

Declaration

public string LicenseConcluded { get; set; }

Property Value

Type	Description
System.String

LicenseDeclared

License expression for licenseDeclared. The licensing that the creators of the software in the package, or the packager, have declared. Declarations by the original software creator should be preferred, if they exist.

Declaration

public string LicenseDeclared { get; set; }

Property Value

Type	Description
System.String

LicenseInfoFromFiles

The licensing information that was discovered directly within the package. There will be an instance of this property for each distinct value of alllicenseInfoInFile properties of all files contained in the package.

Declaration

public List<string> LicenseInfoFromFiles { get; set; }

Property Value

Type	Description
List<System.String>

Name

Identify name of this SpdxElement.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Originator

The name and, optionally, contact information of the person or organization that originally created the package. Values of this property must conform to the agent and tool syntax.

Declaration

public string Originator { get; set; }

Property Value

Type	Description
System.String

PackageFileName

The base name of the package file name. For example, zlib-1.2.5.tar.gz.

Declaration

public string PackageFileName { get; set; }

Property Value

Type	Description
System.String

PackageVerificationCode

A manifest based verification code (the algorithm is defined in section 4.7 of the full specification) of the SPDX Item. This allows consumers of this data and/or database to determine if an SPDX item they have in hand is identical to the SPDX item from which the data was produced. This algorithm works even if the SPDX document is included in the SPDX item.

Declaration

public PackageVerificationCode PackageVerificationCode { get; set; }

Property Value

Type	Description
PackageVerificationCode

SourceInfo

Allows the producer(s) of the SPDX document to describe how the package was acquired and/or changed from the original source.

Declaration

public string SourceInfo { get; set; }

Property Value

Type	Description
System.String

SPDXID

Uniquely identify any element in an SPDX document which may be referenced by other elements.

Declaration

public string SPDXID { get; set; }

Property Value

Type	Description
System.String

Summary

Provides a short description of the package.

Declaration

public string Summary { get; set; }

Property Value

Type	Description
System.String

Supplier

The name and, optionally, contact information of the person or organization who was the immediate supplier of this package to the recipient. The supplier may be different than originator when the software has been repackaged. Values of this property must conform to the agent and tool syntax.

Declaration

public string Supplier { get; set; }

Property Value

Type	Description
System.String

VersionInfo

Provides an indication of the version of the package that is described by this SpdxDocument.

Declaration

public string VersionInfo { get; set; }

Property Value

Type	Description
System.String