Package org.spdx.library.model.license

Class AbstractExtractedLicenseInfo

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

All Implemented Interfaces:

Comparable<AbstractExtractedLicenseInfo>

Direct Known Subclasses:

ExternalExtractedLicenseInfo, ExtractedLicenseInfo

public abstract class AbstractExtractedLicenseInfo
extends SimpleLicensingInfo
implements Comparable<AbstractExtractedLicenseInfo>

ExtractedLicenseInfo which can be represented as a concrete ExtractedLicenseInfo within the same SPDX document with all properties accessible, or as an ExternalExtractedLicenseInfo which represents a license not included within the SPDX document.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractExtractedLicenseInfo o)
abstract String	getExtractedText()
String	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

_verify, 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, getType, 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

AbstractExtractedLicenseInfo

public AbstractExtractedLicenseInfo(String id) throws InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo using the ID

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

AbstractExtractedLicenseInfo

public AbstractExtractedLicenseInfo(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create) throws InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo 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

Method Details

toString

public String toString()

Specified by:

toString in class AnyLicenseInfo

getExtractedText

public abstract String getExtractedText() throws InvalidSPDXAnalysisException

Returns:

the text

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

compareTo

public int compareTo(AbstractExtractedLicenseInfo o)

Specified by:

compareTo in interface Comparable<AbstractExtractedLicenseInfo>