Package org.spdx.library.model

Class SpdxSnippet.SpdxSnippetBuilder

java.lang.Object

org.spdx.library.model.SpdxSnippet.SpdxSnippetBuilder

Enclosing class:

SpdxSnippet

public static class SpdxSnippet.SpdxSnippetBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
SpdxSnippetBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, SpdxFile snippetFromFile, int startByte, int endByte)	Build a snippet with the required parameters

Method Summary

Modifier and Type	Method	Description
SpdxSnippet.SpdxSnippetBuilder	addAnnotation(Annotation annotation)
SpdxSnippet.SpdxSnippetBuilder	addAttributionText(String attribution)	Add attribution to the attribution text collection
SpdxSnippet.SpdxSnippetBuilder	addRelationship(Relationship relationship)
SpdxSnippet	build()
SpdxSnippet.SpdxSnippetBuilder	setAnnotations(Collection<Annotation> annotations)
SpdxSnippet.SpdxSnippetBuilder	setAttributionText(Collection<String> attributionText)	Set the attribution test
SpdxSnippet.SpdxSnippetBuilder	setComment(String comment)
SpdxSnippet.SpdxSnippetBuilder	setLicenseComments(String licenseComments)
SpdxSnippet.SpdxSnippetBuilder	setLineRange(int startLine, int endLine)
SpdxSnippet.SpdxSnippetBuilder	setRelationship(Collection<Relationship> relationships)

Methods inherited from class java.lang.Object

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

Constructor Details

SpdxSnippetBuilder

public SpdxSnippetBuilder(IModelStore modelStore,
 String documentUri,
 String id,
 @Nullable
 ModelCopyManager copyManager,
 String name,
 AnyLicenseInfo concludedLicense,
 Collection<AnyLicenseInfo> licenseInfosFromFile,
 String copyrightText,
 SpdxFile snippetFromFile,
 int startByte,
 int endByte)

Build a snippet 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

snippetFromFile - File where the snippet is located

startByte - first byte of the snippet in the file

endByte - end byte of the snippet in the file

Method Details

setAnnotations

public SpdxSnippet.SpdxSnippetBuilder setAnnotations(Collection<Annotation> annotations)

Parameters:

annotations - Annotations

Returns:

this to continue the build

addAnnotation

public SpdxSnippet.SpdxSnippetBuilder addAnnotation(Annotation annotation)

Parameters:

annotation - Annotation to add

Returns:

this to continue the build

setRelationship

public SpdxSnippet.SpdxSnippetBuilder setRelationship(Collection<Relationship> relationships)

Parameters:

relationships - Relationships

Returns:

this to continue the build

addRelationship

public SpdxSnippet.SpdxSnippetBuilder addRelationship(Relationship relationship)

Parameters:

relationship - Relationship to add

Returns:

this to continue the build

setComment

public SpdxSnippet.SpdxSnippetBuilder setComment(@Nullable
 String comment)

Parameters:

comment - Comment

Returns:

this to continue the build

setLicenseComments

public SpdxSnippet.SpdxSnippetBuilder setLicenseComments(@Nullable
 String licenseComments)

Parameters:

licenseComments -

Returns:

this to continue the build

setAttributionText

public SpdxSnippet.SpdxSnippetBuilder setAttributionText(Collection<String> attributionText)

Set the attribution test

Parameters:

attributionText - Attribution text for the file

Returns:

this to continue the build

addAttributionText

public SpdxSnippet.SpdxSnippetBuilder addAttributionText(String attribution)

Add attribution to the attribution text collection

Parameters:

attribution -

Returns:

this to continue the build

setLineRange

public SpdxSnippet.SpdxSnippetBuilder setLineRange(int startLine,
 int endLine)

Parameters:

startLine - first line of the snippet

endLine - end line of the snippet

Returns:

this to continue the build

build

public SpdxSnippet build()
                  throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException