Package org.spdx.library.model

Class SpdxFile.SpdxFileBuilder

java.lang.Object

org.spdx.library.model.SpdxFile.SpdxFileBuilder

Enclosing class:

SpdxFile

public static class SpdxFile.SpdxFileBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
SpdxFileBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, Checksum sha1)	Build a file with the required parameters

Method Summary

Modifier and Type	Method	Description
SpdxFile.SpdxFileBuilder	addAnnotation(Annotation annotation)
SpdxFile.SpdxFileBuilder	addAttributionText(String attribution)	Add attribution to the attribution text collection
SpdxFile.SpdxFileBuilder	addChecksum(Checksum checksum)
SpdxFile.SpdxFileBuilder	addFileContributor(String fileContributor)
SpdxFile.SpdxFileBuilder	addFileType(FileType fileType)
SpdxFile.SpdxFileBuilder	addRelationship(Relationship relationship)
SpdxFile	build()
SpdxFile.SpdxFileBuilder	setAnnotations(Collection<Annotation> annotations)
SpdxFile.SpdxFileBuilder	setAttributionText(Collection<String> attributionText)
SpdxFile.SpdxFileBuilder	setChecksums(Collection<Checksum> checksums)
SpdxFile.SpdxFileBuilder	setComment(String comment)
SpdxFile.SpdxFileBuilder	setFileContributors(Collection<String> fileContributors)
SpdxFile.SpdxFileBuilder	setFileTypes(Collection<FileType> fileTypes)
SpdxFile.SpdxFileBuilder	setLicenseComments(String licenseComments)
SpdxFile.SpdxFileBuilder	setNoticeText(String noticeText)
SpdxFile.SpdxFileBuilder	setRelationship(Collection<Relationship> relationships)

Methods inherited from class java.lang.Object

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

Constructor Details

SpdxFileBuilder

public SpdxFileBuilder(IModelStore modelStore, String documentUri, String id, @Nullable ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, Checksum sha1)

Build a file with the required parameters

Parameters:

modelStore - Storage for the model objects

documentUri - SPDX Document URI for a document associated with this model

id - ID for this object - must be unique within the SPDX document

copyManager - if non-null, allows for copying of any properties set which use other model stores or document URI's

name - - File name

concludedLicense - license concluded

licenseInfosFromFile - collection of seen licenses

copyrightText - Copyright text

sha1 - - Sha1 checksum value

Method Details

setAnnotations

public SpdxFile.SpdxFileBuilder setAnnotations(Collection<Annotation> annotations)

Parameters:

annotations - Annotations

Returns:

this to continue the build

addAnnotation

public SpdxFile.SpdxFileBuilder addAnnotation(Annotation annotation)

Parameters:

annotation - Annotation to add

Returns:

this to continue the build

setRelationship

public SpdxFile.SpdxFileBuilder setRelationship(Collection<Relationship> relationships)

Parameters:

relationships - Relationships

Returns:

this to continue the build

addRelationship

public SpdxFile.SpdxFileBuilder addRelationship(Relationship relationship)

Parameters:

relationship - Relationship to add

Returns:

this to continue the build

setComment

public SpdxFile.SpdxFileBuilder setComment(@Nullable String comment)

Parameters:

comment - Comment

Returns:

this to continue the build

setLicenseComments

public SpdxFile.SpdxFileBuilder setLicenseComments(@Nullable String licenseComments)

Parameters:

licenseComments -

Returns:

this to continue the build

setChecksums

public SpdxFile.SpdxFileBuilder setChecksums(Collection<Checksum> checksums)

Parameters:

checksums - Checksum

Returns:

this to continue the build

addChecksum

public SpdxFile.SpdxFileBuilder addChecksum(Checksum checksum)

Parameters:

checksum - Checksum to add

Returns:

this to continue the build

setFileContributors

public SpdxFile.SpdxFileBuilder setFileContributors(Collection<String> fileContributors)

Parameters:

fileContributors - Contributors to the file

Returns:

this to continue the build

addFileContributor

public SpdxFile.SpdxFileBuilder addFileContributor(String fileContributor)

Parameters:

fileContributor - File contributor to add

Returns:

this to continue the build

setFileTypes

public SpdxFile.SpdxFileBuilder setFileTypes(Collection<FileType> fileTypes)

Parameters:

fileTypes - file types

Returns:

this to continue the build

addFileType

public SpdxFile.SpdxFileBuilder addFileType(FileType fileType)

Parameters:

fileType - file type to add

Returns:

this to continue the build

setNoticeText

public SpdxFile.SpdxFileBuilder setNoticeText(@Nullable String noticeText)

Parameters:

noticeText - Notice text found in the file

Returns:

this to continue the build

setAttributionText

public SpdxFile.SpdxFileBuilder setAttributionText(Collection<String> attributionText)

Parameters:

attributionText - Attribution text for the file

Returns:

this to continue the build

addAttributionText

public SpdxFile.SpdxFileBuilder addAttributionText(String attribution)

Add attribution to the attribution text collection

Parameters:

attribution -

Returns:

build

public SpdxFile build() throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException