Package org.spdx.library.model.license

Class ExternalExtractedLicenseInfo

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

All Implemented Interfaces:

Comparable<AbstractExtractedLicenseInfo>, IndividualUriValue

public class ExternalExtractedLicenseInfo
extends AbstractExtractedLicenseInfo
implements IndividualUriValue

Author:

Gary O'Neall This class represents an ExtractedLicenseInfo which is stored in an external SPDX document. Note that the actual properties for this ExtractedLicenseInfo is in an external document so it is not accessible through this class. The set methods will cause an exception. The getExtractedText() will return text that indicates the actual license text is in an external document. The ID must be in the form SpdxConstants.EXTERNAL_LICENSE_REF_PATTERN.pattern()

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
ExternalExtractedLicenseInfo(String id)
ExternalExtractedLicenseInfo(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
boolean	equals(Object comp)
boolean	equivalent(ModelObject compare)
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
static String	externalExtractedLicenseIdToURI(String externalExtractedLicenseId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
String	getComment()
String	getExternalDocumentId()
String	getExternalExtractedLicenseURI()
String	getExternalLicenseRef()
String	getExtractedText()
String	getIndividualURI()
String	getName()
Collection<String>	getSeeAlso()
String	getType()
int	hashCode()
void	setComment(String comment)
void	setName(String name)
void	setSeeAlso(Collection<String> seeAlsoUrl)
static ExternalExtractedLicenseInfo	uriToExternalExtractedLicense(String externalLicenseUri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static String	uriToExternalExtractedLicenseId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Convert a URI to an ID for an External Extracted License

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

compareTo, toString

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

getLicenseId

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, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, 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

ExternalExtractedLicenseInfo

public ExternalExtractedLicenseInfo(String id) throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

ExternalExtractedLicenseInfo

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

getExternalDocumentId

public String getExternalDocumentId() throws InvalidSPDXAnalysisException

Returns:

external document ID for the external reference

Throws:

InvalidSPDXAnalysisException

getExternalLicenseRef

public String getExternalLicenseRef() throws InvalidSPDXAnalysisException

Returns:

element ID used in the external document

Throws:

InvalidSPDXAnalysisException

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

_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:

Any verification errors or warnings associated with this object

getExternalExtractedLicenseURI

public String getExternalExtractedLicenseURI() throws InvalidSPDXAnalysisException

Returns:

the URI associated with this external SPDX Extracted License

Throws:

InvalidSPDXAnalysisException

externalExtractedLicenseIdToURI

public static String externalExtractedLicenseIdToURI(String externalExtractedLicenseId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Parameters:

externalExtractedLicenseId -

stModelStore -

stDocumentUri -

copyManager -

Returns:

The URI associated with the external LicenseRef with the ID externalLicenseRefId

Throws:

InvalidSPDXAnalysisException

uriToExternalExtractedLicense

public static ExternalExtractedLicenseInfo uriToExternalExtractedLicense(String externalLicenseUri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Parameters:

externalLicenseUri - URI of the form externaldocumentnamespace#LicenseRef-XXXXX

stModelStore -

stDocumentUri -

copyManager - if non-null, create the external doc ref if it is not already in the ModelStore

Returns:

ExternalSpdxRef an ExternalLicenseRef based on a URI of the form externaldocumentnamespace#LicenseRef-XXXXX

Throws:

InvalidSPDXAnalysisException

uriToExternalExtractedLicenseId

public static String uriToExternalExtractedLicenseId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Convert a URI to an ID for an External Extracted License

Parameters:

uri - URI with the external document namespace and the external Extracted License in the form namespace#LicenseRef-XXXX

stModelStore -

stDocumentUri -

copyManager - if non-null, create the external doc ref if it is not already in the ModelStore

Returns:

external SPDX element ID in the form DocumentRef-XX:LicenseRef-XXXX

Throws:

InvalidSPDXAnalysisException

equivalent

public boolean equivalent(ModelObject compare)

Overrides:

equivalent in class ModelObject

Returns:

true if all the properties have the same or equivalent values

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

getIndividualURI

public String getIndividualURI()

Specified by:

getIndividualURI in interface IndividualUriValue

Returns:

a unique identifier for this value. Typically the namespace + the long name

getExtractedText

public String getExtractedText() throws InvalidSPDXAnalysisException

Specified by:

getExtractedText in class AbstractExtractedLicenseInfo

Returns:

the text

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

getComment

public String getComment() throws InvalidSPDXAnalysisException

Overrides:

getComment in class SimpleLicensingInfo

Returns:

the comments

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setComment

public void setComment(String comment) throws InvalidSPDXAnalysisException

Overrides:

setComment in class SimpleLicensingInfo

Parameters:

comment - the comment to set

Throws:

InvalidSPDXAnalysisException

getSeeAlso

public Collection<String> getSeeAlso() throws InvalidSPDXAnalysisException

Overrides:

getSeeAlso in class SimpleLicensingInfo

Returns:

the urls which reference the same license information

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setSeeAlso

public void setSeeAlso(Collection<String> seeAlsoUrl) throws InvalidSPDXAnalysisException

Overrides:

setSeeAlso in class SimpleLicensingInfo

Parameters:

seeAlsoUrl - the urls which are references to the same license to set

Throws:

InvalidSPDXAnalysisException

getName

public String getName() throws InvalidSPDXAnalysisException

Overrides:

getName in class SimpleLicensingInfo

Returns:

the name

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setName

public void setName(String name) throws InvalidSPDXAnalysisException

Overrides:

setName in class SimpleLicensingInfo

Parameters:

name - the name to set

Throws:

InvalidSPDXAnalysisException

equals

public boolean equals(Object comp)

Overrides:

equals in class ModelObject

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObject