Package org.spdx.library.model.v2.license

Class AbstractExtractedLicenseInfo

java.lang.Object

org.spdx.core.CoreModelObject

org.spdx.library.model.v2.ModelObjectV2

org.spdx.library.model.v2.license.AnyLicenseInfo

org.spdx.library.model.v2.license.SimpleLicensingInfo

org.spdx.library.model.v2.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

Nested Class Summary

Nested classes/interfaces inherited from class org.spdx.core.CoreModelObject

org.spdx.core.CoreModelObject.CoreModelObjectBuilder

Field Summary

Fields inherited from class org.spdx.library.model.v2.ModelObjectV2

LATEST_SPDX_2_VERSION

Fields inherited from class org.spdx.core.CoreModelObject

copyManager, idPrefix, modelStore, objectUri, specVersion, strict

Constructor Summary

Constructors

Constructor	Description
AbstractExtractedLicenseInfo(String id)	Create a new ExtractedLicenseInfo using the ID
AbstractExtractedLicenseInfo(org.spdx.storage.IModelStore modelStore, String documentUri, String id, org.spdx.core.IModelCopyManager 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.v2.license.SimpleLicensingInfo

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

Methods inherited from class org.spdx.library.model.v2.ModelObjectV2

_verify, _verify, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createExtractedLicense, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, equals, getAnyLicenseInfoPropertyValue, getDocumentUri, getElementPropertyValue, getId, hashCode, isEquivalentToNull, isNoAssertion, isRelatedElement, toTypedValue, verify

Methods inherited from class org.spdx.core.CoreModelObject

addPropertyValueToCollection, clearValueCollection, clone, copyFrom, enterCriticalSection, equivalent, equivalent, getBooleanPropertyValue, getCopyManager, getDoublePropertyValue, getEnumPropertyValue, getIdPrefix, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getObjectUri, getPropertyValueDescriptors, getSpecVersion, getStringCollection, getStringPropertyValue, getType, isCollectionMembersAssignableTo, isExternal, isStrict, leaveCriticalSection, removeProperty, removePropertyValueFromCollection, setCopyManager, setIdPrefix, setPropertyValue, setStrict, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExtractedLicenseInfo

public AbstractExtractedLicenseInfo(String id)
                             throws org.spdx.core.InvalidSPDXAnalysisException

Create a new ExtractedLicenseInfo using the ID

Parameters:

id - identifier for the license

Throws:

org.spdx.core.InvalidSPDXAnalysisException

AbstractExtractedLicenseInfo

public AbstractExtractedLicenseInfo(org.spdx.storage.IModelStore modelStore,
                                    String documentUri,
                                    String id,
                                    org.spdx.core.IModelCopyManager copyManager,
                                    boolean create)
                             throws org.spdx.core.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:

org.spdx.core.InvalidSPDXAnalysisException

Method Detail

toString

public String toString()

Specified by:

toString in class AnyLicenseInfo

getExtractedText

public abstract String getExtractedText()
                                 throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the text

Throws:

org.spdx.core.InvalidSPDXAnalysisException

compareTo

public int compareTo(AbstractExtractedLicenseInfo o)

Specified by:

compareTo in interface Comparable<AbstractExtractedLicenseInfo>