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.AbstractExtractedLicenseInfo

org.spdx.library.model.license.ExtractedLicenseInfo

All Implemented Interfaces:

Comparable<AbstractExtractedLicenseInfo>

public class ExtractedLicenseInfo
extends AbstractExtractedLicenseInfo

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()	Create a new ExtractedLicenseInfo object
ExtractedLicenseInfo(String id)	Create a new ExtractedLicenseInfo object
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 ExtractedLicenseInfo object

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
boolean	equivalent(ModelObject compare)
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
String	getExtractedText()
String	getType()
void	setExtractedText(String text)	Sets the license text.

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

compareTo, toString

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

getComment, 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, createExtractedLicense, 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, verify, verifyCollection

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractedLicenseInfo

public ExtractedLicenseInfo()
                     throws InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo object

Users of the library should not call this constructor directly but use SpdxDocument#createExtractedLicense. This ensures correct behaviour between that document and its ExtractedLicenseInfo instance.

Otherwise, the object may misbehave, such as with SpdxDocument#addExtractedLicenseInfos.

Throws:

InvalidSPDXAnalysisException

ExtractedLicenseInfo

public ExtractedLicenseInfo(String id)
                     throws InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo object

Users of the library should not call this constructor directly but use SpdxDocument#createExtractedLicense. This ensures correct behaviour between that document and its ExtractedLicenseInfo instance.

Otherwise, the object may misbehave, such as with SpdxDocument#addExtractedLicenseInfos.

Parameters:

id - identifier for the license

Throws:

InvalidSPDXAnalysisException

ExtractedLicenseInfo

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

Create a new ExtractedLicenseInfo object

Users of the library should prefer SpdxDocument#createExtractedLicense.

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

Users of the library should not call this constructor directly but use SpdxDocument#createExtractedLicense. This ensures correct behaviour between that document and its ExtractedLicenseInfo instance.

Otherwise, the object may misbehave, such as with SpdxDocument#addExtractedLicenseInfos.

Parameters:

id - identifier for the license

text - text to associate with the license

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

getExtractedText

public String getExtractedText()
                        throws InvalidSPDXAnalysisException

Specified by:

getExtractedText in class AbstractExtractedLicenseInfo

Returns:

the text

Throws:

SpdxInvalidTypeException

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setExtractedText

public void setExtractedText(String text)
                      throws InvalidSPDXAnalysisException

Sets the license text.

Affects both this object and the underlying store.

Parameters:

text - text to associate with the license

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

Specified by:

_verify in class ModelObject

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:

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