Class SpdxDocument

Inheritance
System.Object
SpdxDocument
Namespace: CycloneDX.Spdx.Models.v2_2
Assembly: CycloneDX.Spdx.dll
Syntax
public class SpdxDocument : object

Properties

| Improve this Doc View Source

Annotations

Provide additional information about an SpdxElement.

Declaration
public List<Annotation> Annotations { get; set; }
Property Value
Type Description
List<Annotation>
| Improve this Doc View Source

Comment

Declaration
public string Comment { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CreationInfo

One instance is required for each SPDX file produced. It provides the necessary information for forward and backward compatibility for processing tools.

Declaration
public CreationInfo CreationInfo { get; set; }
Property Value
Type Description
CreationInfo
| Improve this Doc View Source

DataLicense

License expression for dataLicense. Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata"). The SPDX specification contains numerous fields where an SPDX document creator may provide relevant explanatory text in SPDX-Metadata. Without opining on the lawfulness of "database rights" (in jurisdictions where applicable), such explanatory text is copyrightable subject matter in most Berne Convention countries. By using the SPDX specification, or any portion hereof, you hereby agree that any copyright rights (as determined by your jurisdiction) in any SPDX-Metadata, including without limitation explanatory text, shall be subject to the terms of the Creative Commons CC0 1.0 Universal license. For SPDX-Metadata not containing any copyright rights, you hereby agree and acknowledge that the SPDX-Metadata is provided to you "as-is" and without any representations or warranties of any kind concerning the SPDX-Metadata, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non-infringement, or the absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.

Declaration
public string DataLicense { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DocumentDescribes

Packages, files and/or Snippets described by this SPDX document

Declaration
public List<string> DocumentDescribes { get; set; }
Property Value
Type Description
List<System.String>
| Improve this Doc View Source

DocumentNamespace

The URI provides an unambiguous mechanism for other SPDX documents to reference SPDX elements within this SPDX document.

Declaration
public string DocumentNamespace { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ExternalDocumentRefs

Identify any external SPDX documents referenced within this SPDX document.

Declaration
public List<ExternalDocumentRef> ExternalDocumentRefs { get; set; }
Property Value
Type Description
List<ExternalDocumentRef>
| Improve this Doc View Source

Files

Files referenced in the SPDX document

Declaration
public List<File> Files { get; set; }
Property Value
Type Description
List<File>
| Improve this Doc View Source

HasExtractedLicensingInfos

Indicates that a particular ExtractedLicensingInfo was defined in the subject SpdxDocument.

Declaration
public List<ExtractedLicensingInfo> HasExtractedLicensingInfos { get; set; }
Property Value
Type Description
List<ExtractedLicensingInfo>
| Improve this Doc View Source

Name

Identify name of this SpdxElement.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Packages

Packages referenced in the SPDX document

Declaration
public List<Package> Packages { get; set; }
Property Value
Type Description
List<Package>
| Improve this Doc View Source

Relationships

Relationships referenced in the SPDX document

Declaration
public List<Relationship> Relationships { get; set; }
Property Value
Type Description
List<Relationship>
| Improve this Doc View Source

Revieweds

Reviewed

Declaration
public List<ReviewInformation> Revieweds { get; set; }
Property Value
Type Description
List<ReviewInformation>
| Improve this Doc View Source

Snippets

Snippets referenced in the SPDX document

Declaration
public List<Snippet> Snippets { get; set; }
Property Value
Type Description
List<Snippet>
| Improve this Doc View Source

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
| Improve this Doc View Source

SpdxVersion

Provide a reference number that can be used to understand how to parse and interpret the rest of the file. It will enable both future changes to the specification and to support backward compatibility. The version number consists of a major and minor version indicator. The major field will be incremented when incompatible changes between versions are made (one or more sections are created, modified or deleted). The minor field will be incremented when backwards compatible changes are made.

Declaration
public string SpdxVersion { get; }
Property Value
Type Description
System.String

Extension Methods