Class File

Inheritance

System.Object

File

Namespace: CycloneDX.Spdx.Models.v2_2

Assembly: CycloneDX.Spdx.dll

Syntax

public class File : object

Properties

Annotations

Provide additional information about an SpdxElement.

Declaration

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

Property Value

Type	Description
List<Annotation>

ArtifactOfs

Indicates the project in which the SpdxElement originated. Tools must preserve doap:homepage and doap:name properties and the URI (if one is known) of doap:Project resources that are values of this property. All other properties of doap:Projects are not directly supported by SPDX and may be dropped when translating to or from some SPDX formats.

Declaration

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

Property Value

Type	Description
List<System.String>

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

FileContributors

This field provides a place for the SPDX file creator to record file contributors. Contributors could include names of copyright holders and/or authors who may not be copyright holders yet contributed to the file content.

Declaration

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

Property Value

Type	Description
List<System.String>

FileDependencies

Declaration

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

Property Value

Type	Description
List<System.String>

FileName

The name of the file relative to the root of the package.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String

FileTypes

The type of the file.

Declaration

public List<FileType> FileTypes { get; set; }

Property Value

Type	Description
List<FileType>

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

LicenseInfoInFiles

Licensing information that was discovered directly in the subject file. This is also considered a declared license for the file.

Declaration

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

Property Value

Type	Description
List<System.String>

NoticeText

This field provides a place for the SPDX file creator to record potential legal notices found in the file. This may or may not include copyright statements.

Declaration

public string NoticeText { 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