Package org.spdx.library.model

Class SpdxSnippet

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxItem

org.spdx.library.model.SpdxSnippet

All Implemented Interfaces:

Comparable<SpdxSnippet>

public class SpdxSnippet
extends SpdxItem
implements Comparable<SpdxSnippet>

Snippets can optionally be used when a file is known to have some content that has been included from another original source. They are useful for denoting when part of a file may have been originally created under another license. Each instance of Snippet Information needs to be associated with a specific File in an SPDX Document.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpdxSnippet.SpdxSnippetBuilder

Field Summary

Fields inherited from class org.spdx.library.model.ModelObject

strict

Constructor Summary

Constructors

Constructor	Description
SpdxSnippet()
SpdxSnippet(String id)
SpdxSnippet(SpdxSnippet.SpdxSnippetBuilder spdxSnippetBuilder)
SpdxSnippet(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(Set<String> verifiedIds, String specVersion)	Implementation of the specific verifications for this model object
int	compareTo(SpdxSnippet o)
StartEndPointer	getByteRange()
String	getLicenseInfoFromFilesPropertyName()
Optional<StartEndPointer>	getLineRange()
SpdxFile	getSnippetFromFile()
String	getType()
SpdxSnippet	setByteRange(int startByte, int endByte)
SpdxSnippet	setLineRange(int startLine, int endLine)
SpdxSnippet	setSnippetFromFile(SpdxFile snippetFromFile)
String	toString()

Methods inherited from class org.spdx.library.model.SpdxItem

getAttributionText, getCopyrightText, getLicenseComments, getLicenseConcluded, getLicenseInfoFromFiles, setCopyrightText, setLicenseComments, setLicenseConcluded, setName

Methods inherited from class org.spdx.library.model.SpdxElement

addAnnotation, addNameToWarnings, addRelationship, getAnnotations, getComment, getName, getNamePropertyName, getRelationships, removeAnnotation, removeRelationship, setAnnotations, setComment, setRelationships

Methods inherited from class org.spdx.library.model.ModelObject

addPropertyValueToCollection, addValueToCollection, clearValueCollection, clearValueCollection, clone, copyFrom, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, enterCriticalSection, equals, equivalent, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, hashCode, idToIdType, isCollectionMembersAssignableTo, isStrict, leaveCriticalSection, removeProperty, removeProperty, removePropertyValueFromCollection, removePropertyValueFromCollection, replacePropertyValueCollection, setCopyManager, setPropertyValue, setPropertyValue, setStrict, toTypedValue, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SpdxSnippet

public SpdxSnippet() throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxSnippet

public SpdxSnippet(String id) throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SpdxSnippet

public SpdxSnippet(IModelStore modelStore, String documentUri, String id, @Nullable ModelCopyManager copyManager, boolean create) throws InvalidSPDXAnalysisException

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

SpdxSnippet

public SpdxSnippet(SpdxSnippet.SpdxSnippetBuilder spdxSnippetBuilder) throws InvalidSPDXAnalysisException

Parameters:

spdxSnippetBuilder -

Throws:

InvalidSPDXAnalysisException

Method Details

getType

public String getType()

Specified by:

getType in class ModelObject

Returns:

The class name for this object. Class names are defined in the constants file

getLicenseInfoFromFilesPropertyName

public String getLicenseInfoFromFilesPropertyName()

Overrides:

getLicenseInfoFromFilesPropertyName in class SpdxItem

Returns:

Property name for licenseInfoFromFiles. Override if using a subproperty of "licenseDeclared".

getSnippetFromFile

@Nullable public SpdxFile getSnippetFromFile() throws InvalidSPDXAnalysisException

Returns:

the snippetFromFile, null if the file is not present in the model

Throws:

InvalidSPDXAnalysisException

setSnippetFromFile

public SpdxSnippet setSnippetFromFile(SpdxFile snippetFromFile) throws InvalidSPDXAnalysisException

Parameters:

snippetFromFile - the snippetFromFile to set

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getByteRange

public StartEndPointer getByteRange() throws InvalidSPDXAnalysisException

Returns:

the byteRange or null if no byte range is present

Throws:

InvalidSPDXAnalysisException

setByteRange

public SpdxSnippet setByteRange(int startByte, int endByte) throws InvalidSPDXAnalysisException

Parameters:

startByte - first byte of the range

endByte - end byte of the range

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getLineRange

public Optional<StartEndPointer> getLineRange() throws InvalidSPDXAnalysisException

Returns:

the lineRange

Throws:

InvalidSPDXAnalysisException

setLineRange

public SpdxSnippet setLineRange(int startLine, int endLine) throws InvalidSPDXAnalysisException

Parameters:

startLine - the start position of lineRange to set, inclusive

endLine - the end position of lineRange to set, exclusive

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

_verify

protected List<String> _verify(Set<String> verifiedIds, String specVersion)

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Overrides:

_verify in class SpdxItem

Parameters:

verifiedIds - list of all Element Id's which have already been verified - prevents infinite recursion

specVersion - Version of the SPDX spec to verify against

Returns:

Any verification errors or warnings associated with this object

compareTo

public int compareTo(SpdxSnippet o)

Specified by:

compareTo in interface Comparable<SpdxSnippet>

toString

public String toString()

Overrides:

toString in class ModelObject