Package org.spdx.library.model.license

Class ExtractedLicenseInfo

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.license.AnyLicenseInfo

org.spdx.library.model.license.SimpleLicensingInfo

org.spdx.library.model.license.ExtractedLicenseInfo

All Implemented Interfaces:

Comparable<ExtractedLicenseInfo>

Direct Known Subclasses:

ExternalExtractedLicenseInfo

public class ExtractedLicenseInfo
extends SimpleLicensingInfo
implements Comparable<ExtractedLicenseInfo>

An ExtractedLicensingInfo represents a license or licensing notice that was found in the package. Any license text that is recognized as a license may be represented as a License rather than an ExtractedLicensingInfo.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
ExtractedLicenseInfo()
ExtractedLicenseInfo(String id)
ExtractedLicenseInfo(String id, String text)	Create a new ExtractedLicenseInfo using the ID and text
ExtractedLicenseInfo(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new SimpleLicensingInfo object

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(List<String> verifiedIds)	Implementation of the specific verifications for this model object
int	compareTo(ExtractedLicenseInfo o)
boolean	equivalent(ModelObject compare)
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
String	getExtractedText()
String	getType()
void	setExtractedText(String text)
String	toString()

Methods inherited from class org.spdx.library.model.license.SimpleLicensingInfo

getComment, getCrossRef, getLicenseId, getName, getSeeAlso, setComment, setName, setSeeAlso

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, 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, verifyCollection

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractedLicenseInfo

public ExtractedLicenseInfo() throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

ExtractedLicenseInfo

public ExtractedLicenseInfo(String id) throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

ExtractedLicenseInfo

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

Create a new SimpleLicensingInfo object

Parameters:

modelStore - container which includes the license

documentUri - URI for the SPDX document containing the license

id - identifier for the license

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

create - if true, create the license if it does not exist

Throws:

InvalidSPDXAnalysisException

ExtractedLicenseInfo

public ExtractedLicenseInfo(String id, String text) throws InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo using the ID and text

Parameters:

id -

text -

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

toString

public String toString()

Specified by:

toString in class AnyLicenseInfo

getExtractedText

public String getExtractedText() throws InvalidSPDXAnalysisException

Returns:

the text

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setExtractedText

public void setExtractedText(String text) throws InvalidSPDXAnalysisException

Parameters:

text - the text to set

Throws:

InvalidSPDXAnalysisException

_verify

protected List<String> _verify(List<String> verifiedIds)

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObject

Parameters:

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

Returns:

compareTo

public int compareTo(ExtractedLicenseInfo o)

Specified by:

compareTo in interface Comparable<ExtractedLicenseInfo>

equivalent

public boolean equivalent(ModelObject compare) throws InvalidSPDXAnalysisException

Overrides:

equivalent in class ModelObject

Returns:

true if all the properties have the same or equivalent values

Throws:

InvalidSPDXAnalysisException

equivalent

public boolean equivalent(ModelObject compare, boolean ignoreRelatedElements) throws InvalidSPDXAnalysisException

Overrides:

equivalent in class ModelObject

ignoreRelatedElements - if true, do not compare properties relatedSpdxElement - used to prevent infinite recursion

Returns:

true if all the properties have the same or equivalent values

Throws:

InvalidSPDXAnalysisException