Package org.spdx.library.model.v2
Class SpdxFile.SpdxFileBuilder
- java.lang.Object
-
- org.spdx.library.model.v2.SpdxFile.SpdxFileBuilder
-
-
Constructor Summary
Constructors Constructor Description SpdxFileBuilder(org.spdx.storage.IModelStore modelStore, String documentUri, String id, org.spdx.core.IModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, Checksum sha1)
Build a file with the required parameters
-
Method Summary
-
-
-
Constructor Detail
-
SpdxFileBuilder
public SpdxFileBuilder(org.spdx.storage.IModelStore modelStore, String documentUri, String id, @Nullable org.spdx.core.IModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, @Nullable Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, Checksum sha1)
Build a file with the required parameters- Parameters:
modelStore
- Storage for the model objectsdocumentUri
- SPDX Document URI for a document associated with this modelid
- ID for this object - must be unique within the SPDX documentcopyManager
- if non-null, allows for copying of any properties set which use other model stores or document URI'sname
- - File nameconcludedLicense
- license concludedlicenseInfosFromFile
- collection of seen licensescopyrightText
- Copyright textsha1
- - Sha1 checksum value
-
-
Method Detail
-
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 org.spdx.core.InvalidSPDXAnalysisException
- Throws:
org.spdx.core.InvalidSPDXAnalysisException
-
-