Package org.spdx.library.model

Class SpdxItem

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxItem

Direct Known Subclasses:

GenericSpdxItem, SpdxFile, SpdxPackage, SpdxSnippet

public abstract class SpdxItem
extends SpdxElement

An SpdxItem is a potentially copyrightable work.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
SpdxItem()
SpdxItem(String id)
SpdxItem(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
Collection<String>	getAttributionText()
String	getCopyrightText()
Optional<String>	getLicenseComments()
AnyLicenseInfo	getLicenseConcluded()
Collection<AnyLicenseInfo>	getLicenseInfoFromFiles()
protected String	getLicenseInfoFromFilesPropertyName()
SpdxItem	setCopyrightText(String copyrightText)
SpdxItem	setLicenseComments(String licenseComments)
SpdxItem	setLicenseConcluded(AnyLicenseInfo license)	Set the licenseConcluded
SpdxItem	setName(String name)	Set the name

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, createExtractedLicense, 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, getType, hashCode, idToIdType, isCollectionMembersAssignableTo, isStrict, leaveCriticalSection, removeProperty, removeProperty, removePropertyValueFromCollection, removePropertyValueFromCollection, replacePropertyValueCollection, setCopyManager, setPropertyValue, setPropertyValue, setStrict, toString, 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

SpdxItem

public SpdxItem()
         throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxItem

public SpdxItem(String id)
         throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SpdxItem

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

getLicenseInfoFromFilesPropertyName

protected String getLicenseInfoFromFilesPropertyName()

Returns:

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

getLicenseConcluded

public AnyLicenseInfo getLicenseConcluded()
                                   throws InvalidSPDXAnalysisException

Returns:

the licenseConcluded

Throws:

InvalidSPDXAnalysisException

setLicenseConcluded

public SpdxItem setLicenseConcluded(@Nullable
 AnyLicenseInfo license)
                             throws InvalidSPDXAnalysisException

Set the licenseConcluded

Parameters:

license -

Returns:

this so you can chain setters

Throws:

InvalidSPDXAnalysisException

getLicenseInfoFromFiles

public Collection<AnyLicenseInfo> getLicenseInfoFromFiles()
                                                   throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getCopyrightText

public String getCopyrightText()
                        throws InvalidSPDXAnalysisException

Returns:

the copyrightText, empty string if no copyright was set

Throws:

InvalidSPDXAnalysisException

setCopyrightText

public SpdxItem setCopyrightText(@Nullable
 String copyrightText)
                          throws InvalidSPDXAnalysisException

Parameters:

copyrightText - the copyrightText to set

Returns:

myself - so you can chain setters

Throws:

InvalidSPDXAnalysisException

getAttributionText

public Collection<String> getAttributionText()
                                      throws InvalidSPDXAnalysisException

Returns:

attribution text collection

Throws:

InvalidSPDXAnalysisException

setName

public SpdxItem setName(String name)
                 throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Set the name

Overrides:

setName in class SpdxElement

Returns:

this so that you can chain setters

Throws:

InvalidSPDXAnalysisException

getLicenseComments

public Optional<String> getLicenseComments()
                                    throws InvalidSPDXAnalysisException

Returns:

the licenseComment

Throws:

InvalidSPDXAnalysisException

setLicenseComments

public SpdxItem setLicenseComments(String licenseComments)
                            throws InvalidSPDXAnalysisException

Parameters:

licenseComments - the licenseComment to set

Returns:

this so you chan 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 SpdxElement

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