A B C D E F G H I L M N O P R S T U V _
All Classes All Packages

A

add(Object) - Method in class org.spdx.core.ModelCollection

add(Object) - Method in class org.spdx.core.ModelSet

addAll(Collection) - Method in class org.spdx.core.ModelSet

addAll(Collection<? extends Object>) - Method in class org.spdx.core.ModelCollection

addHtmlFormatting(String) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Adds HTML formatting <br> and <p>

addHtmlFormatting(String, boolean) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Adds HTML formatting <br> and <p>

addPropertyValueToCollection(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Add a value to a collection of values associated with a property.

addValueToCollection(String, PropertyDescriptor, Object) - Method in interface org.spdx.storage.IModelStore

Adds a value to a property collection creating the propertyDescriptor if it does not exist

addValueToCollection(String, PropertyDescriptor, Object) - Method in class org.spdx.storage.NullModelStore

addValueToCollection(IModelStore, String, PropertyDescriptor, Object, IModelCopyManager, String) - Static method in class org.spdx.core.ModelObjectHelper

Add a value to a collection of values associated with a property.

Anonymous - org.spdx.storage.IModelStore.IdType

apply() - Method in interface org.spdx.storage.IModelStore.ModelUpdate

B

BEGIN_OPTIONAL - org.spdx.licenseTemplate.LicenseTemplateRule.RuleType

beginOptional(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

beginOptional(LicenseTemplateRule) - Method in interface org.spdx.licenseTemplate.ILicenseTemplateOutputHandler

Begin optional rule found

beginOptional(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

C

canBeExternal(Class<?>) - Method in interface org.spdx.core.ISpdxModelInfo

canBeExternal(Class<?>, String) - Method in class org.spdx.core.ModelRegistry

canSkip(String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Returns true if the token can be ignored per the rules

clear() - Method in class org.spdx.core.ModelCollection

clearAll() - Method in class org.spdx.core.ModelRegistry

Removes all the registered models - should only be used in testing

clearValueCollection(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

Sets the value collection for the property to an empty collection creating the propertyDescriptor if it does not exist

clearValueCollection(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

clearValueCollection(IModelStore, String, PropertyDescriptor) - Static method in class org.spdx.core.ModelObjectHelper

Clears a collection of values associated with a property creating the property if it does not exist

clearValueCollection(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

Clears a collection of values associated with a property

clone(IModelStore) - Method in class org.spdx.core.CoreModelObject

Clone a new object using a different model store

close() - Method in class org.spdx.storage.NullModelStore

collectionContains(String, PropertyDescriptor, Object) - Method in interface org.spdx.storage.IModelStore

collectionContains(String, PropertyDescriptor, Object) - Method in class org.spdx.storage.NullModelStore

collectionSize(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

collectionSize(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

COMPARE_PROPERTY_MISSING - org.spdx.core.NotEquivalentReason.NotEquivalent

Indicates that a property to compare is missing.

completeParsing() - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

completeParsing() - Method in interface org.spdx.licenseTemplate.ILicenseTemplateOutputHandler

Signals all text has been added and parsing can be completed.

completeParsing() - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

contains(Object) - Method in class org.spdx.core.ModelCollection

containsAll(Collection<?>) - Method in class org.spdx.core.ModelCollection

containsSpecVersion(String) - Method in class org.spdx.core.ModelRegistry

copy(IModelStore, String, IModelStore, String, String, String) - Method in interface org.spdx.core.IModelCopyManager

Copy an item from one Model Object Store to another

copy(IModelStore, IModelStore, String, String, String) - Method in interface org.spdx.core.IModelCopyManager

Copy an item from one Model Object Store to another using the source ID for the target unless it is anonymous

copyFrom(CoreModelObject) - Method in class org.spdx.core.CoreModelObject

Copy all the properties from the source object

copyManager - Variable in class org.spdx.core.CoreModelObject

If non-null, a reference made to a model object stored in a different modelStore and/or document will be copied to this modelStore and documentUri

CoreModelObject - Class in org.spdx.core

Superclass for all SPDX model objects

CoreModelObject(String) - Constructor for class org.spdx.core.CoreModelObject

Create a new Model Object using an Anonymous ID with the default store and default document URI

CoreModelObject(String, String) - Constructor for class org.spdx.core.CoreModelObject

Open or create a model object with the default store

CoreModelObject(CoreModelObject.CoreModelObjectBuilder, String) - Constructor for class org.spdx.core.CoreModelObject

CoreModelObject(IModelStore, String, IModelCopyManager, boolean, String, String) - Constructor for class org.spdx.core.CoreModelObject

Creates a new model object

CoreModelObject.CoreModelObjectBuilder - Class in org.spdx.core

Base builder class for all model objects

CoreModelObjectBuilder(IModelStore, String, IModelCopyManager) - Constructor for class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

create(TypedValue) - Method in interface org.spdx.storage.IModelStore

Create a new object with objectUri, type and version from the typedValue

create(TypedValue) - Method in class org.spdx.storage.NullModelStore

createExternalElement(IModelStore, String, IModelCopyManager, Class<?>, String) - Method in interface org.spdx.core.ISpdxModelInfo

createModelObject(IModelStore, String, String, IModelCopyManager, String, boolean, String) - Method in interface org.spdx.core.ISpdxModelInfo

D

DefaultModelStore - Class in org.spdx.core

Singleton class to hold a default model store used when no model store is provided

DefaultStoreNotInitializedException - Exception in org.spdx.core

Exception where the default store is used before it has been initialized

DefaultStoreNotInitializedException() - Constructor for exception org.spdx.core.DefaultStoreNotInitializedException

DefaultStoreNotInitializedException(String) - Constructor for exception org.spdx.core.DefaultStoreNotInitializedException

DefaultStoreNotInitializedException(String, Throwable) - Constructor for exception org.spdx.core.DefaultStoreNotInitializedException

DefaultStoreNotInitializedException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.DefaultStoreNotInitializedException

DefaultStoreNotInitializedException(Throwable) - Constructor for exception org.spdx.core.DefaultStoreNotInitializedException

delete(String) - Method in interface org.spdx.storage.IModelStore

Deletes an item from the document

delete(String) - Method in class org.spdx.storage.NullModelStore

deSerialize(InputStream, boolean) - Method in interface org.spdx.storage.ISerializableModelStore

Deserialize / read an SPDX document from a stream

DIFFERENT_CLASS - org.spdx.core.NotEquivalentReason.NotEquivalent

Indicates that the objects are of different classes.

DocumentRef - org.spdx.storage.IModelStore.IdType

DuplicateSpdxIdException - Exception in org.spdx.core

Exception for duplicate SPDX ID creations

DuplicateSpdxIdException() - Constructor for exception org.spdx.core.DuplicateSpdxIdException

DuplicateSpdxIdException(String) - Constructor for exception org.spdx.core.DuplicateSpdxIdException

DuplicateSpdxIdException(String, Throwable) - Constructor for exception org.spdx.core.DuplicateSpdxIdException

DuplicateSpdxIdException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.DuplicateSpdxIdException

DuplicateSpdxIdException(Throwable) - Constructor for exception org.spdx.core.DuplicateSpdxIdException

E

END_OPTIONAL - org.spdx.licenseTemplate.LicenseTemplateRule.RuleType

END_RULE_PATTERN - Static variable in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

endOptional(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

endOptional(LicenseTemplateRule) - Method in interface org.spdx.licenseTemplate.ILicenseTemplateOutputHandler

End optional rule found

endOptional(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

enterCriticalSection(boolean) - Method in class org.spdx.core.CoreModelObject

Enter a critical section.

enterCriticalSection(boolean) - Method in interface org.spdx.storage.IModelStore

Enter a critical section.

enterCriticalSection(boolean) - Method in class org.spdx.storage.NullModelStore

equals(Object) - Method in class org.spdx.core.CoreModelObject

equals(Object) - Method in class org.spdx.core.SimpleUriValue

equals(Object) - Method in class org.spdx.core.TypedValue

equals(Object) - Method in class org.spdx.storage.PropertyDescriptor

equivalent(CoreModelObject) - Method in class org.spdx.core.CoreModelObject

equivalent(CoreModelObject, boolean) - Method in class org.spdx.core.CoreModelObject

escapeIdString(String) - Static method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

Escape the ID string to conform to the legal characters for an HTML ID string

exists(String) - Method in interface org.spdx.storage.IModelStore

exists(String) - Method in class org.spdx.storage.NullModelStore

externalMap - Variable in class org.spdx.core.ModelCollection

Map of URI's of elements referenced but not present in the store

F

formatEndOptionalHTML(boolean) - Static method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

formatEscapeHTML(String) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Escapes and formats text

formatEscapeHTML(String, boolean) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Escapes and formats text

formatReplaceabledHTML(String, String) - Static method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

Deprecated.

formatReplaceableHTML(String, String) - Static method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

Format HTML for a replaceable string

formatStartOptionalHTML(String) - Static method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

Format HTML for an optional string

G

getAllItems(String, String) - Method in interface org.spdx.storage.IModelStore

getAllItems(String, String) - Method in class org.spdx.storage.NullModelStore

getBooleanPropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getCaseSensisitiveId(String, String) - Method in interface org.spdx.storage.IModelStore

Deprecated.

As of release 1.0, replaced by IModelStore.getCaseSensitiveId(String, String)

getCaseSensitiveId(String, String) - Method in interface org.spdx.storage.IModelStore

In SPDX 2.2 license refs are allowed to be matched case-insensitive.

getCaseSensitiveId(String, String) - Method in class org.spdx.storage.NullModelStore

getColumn() - Method in class org.spdx.licenseTemplate.LineColumn

getCopiedObjectUri(IModelStore, String, IModelStore) - Method in interface org.spdx.core.IModelCopyManager

getCopyManager() - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

getCopyManager() - Method in class org.spdx.core.CoreModelObject

getDefaultCopyManager() - Static method in class org.spdx.core.DefaultModelStore

getDefaultDocumentUri() - Static method in class org.spdx.core.DefaultModelStore

getDefaultModelStore() - Static method in class org.spdx.core.DefaultModelStore

getDoublePropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getEnumPropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getExample() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

getExternalElement(IModelStore, String, IModelCopyManager, Class<?>, String) - Method in class org.spdx.core.ModelRegistry

getHtml() - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

getId() - Method in class org.spdx.core.CoreModelObject

getIdPrefix() - Method in class org.spdx.core.CoreModelObject

getIdType(String) - Method in interface org.spdx.storage.IModelStore

getIdType(String) - Method in class org.spdx.storage.NullModelStore

getIndividualURI() - Method in interface org.spdx.core.IndividualUriValue

getIndividualURI() - Method in class org.spdx.core.SimpleUriValue

getIndividualUriValueHash(IndividualUriValue) - Static method in class org.spdx.core.SimpleUriValue

returns hash based on URI of the IndividualUriValue

getIntegerPropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getLen() - Method in class org.spdx.licenseTemplate.LineColumn

getLine() - Method in class org.spdx.licenseTemplate.LineColumn

getMatch() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

getModelRegistry() - Static method in class org.spdx.core.ModelRegistry

getModelStore() - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

getModelStore() - Method in class org.spdx.core.CoreModelObject

getModelStore() - Method in class org.spdx.core.ModelCollection

getName() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

getName() - Method in class org.spdx.storage.PropertyDescriptor

getNameSpace() - Method in class org.spdx.storage.PropertyDescriptor

getNextId(IModelStore.IdType) - Method in interface org.spdx.storage.IModelStore

Generate a unique ID within the model store - Note: for a full URI, the id should be prepended with a URI prefix

getNextId(IModelStore.IdType) - Method in class org.spdx.storage.NullModelStore

getObjectPropertyValue(IModelStore, String, PropertyDescriptor, IModelCopyManager, String, Class<?>, String) - Static method in class org.spdx.core.ModelObjectHelper

Get an object value for a property

getObjectPropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

Get an object value for a property

getObjectPropertyValue(PropertyDescriptor, Class<?>) - Method in class org.spdx.core.CoreModelObject

Get an object value for a property

getObjectPropertyValueCollection(PropertyDescriptor, Class<?>) - Method in class org.spdx.core.CoreModelObject

getObjectPropertyValueSet(PropertyDescriptor, Class<?>) - Method in class org.spdx.core.CoreModelObject

getObjectUri() - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

getObjectUri() - Method in class org.spdx.core.CoreModelObject

getObjectUri() - Method in class org.spdx.core.ModelCollection

getObjectUri() - Method in class org.spdx.core.TypedValue

getOriginal() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

getProperty() - Method in class org.spdx.core.NotEquivalentReason

getPropertyDescriptor() - Method in class org.spdx.core.ModelCollection

getPropertyValueDescriptors() - Method in class org.spdx.core.CoreModelObject

getPropertyValueDescriptors(String) - Method in interface org.spdx.storage.IModelStore

getPropertyValueDescriptors(String) - Method in class org.spdx.storage.NullModelStore

getReason() - Method in class org.spdx.core.NotEquivalentReason

getSpecVersion() - Method in class org.spdx.core.CoreModelObject

getSpecVersion() - Method in class org.spdx.core.TypedValue

getSpecVersions() - Method in interface org.spdx.core.ISpdxModelInfo

getStringCollection(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getStringPropertyValue(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

getSupportedVersions() - Method in class org.spdx.core.ModelRegistry

getText() - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

getTokenAt(String[], int) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Just fetches the string at the index checking for range.

getType() - Method in class org.spdx.core.CoreModelObject

getType() - Method in class org.spdx.core.TypedValue

getType() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

getTypedValue(String) - Method in interface org.spdx.storage.IModelStore

getTypedValue(String) - Method in class org.spdx.storage.NullModelStore

getTypeToClassMap() - Method in interface org.spdx.core.ISpdxModelInfo

getUriToEnumMap() - Method in interface org.spdx.core.ISpdxModelInfo

getValue(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

getValue(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

H

hashCode() - Method in class org.spdx.core.CoreModelObject

hashCode() - Method in class org.spdx.core.SimpleUriValue

hashCode() - Method in class org.spdx.core.TypedValue

hashCode() - Method in class org.spdx.storage.PropertyDescriptor

HtmlTemplateOutputHandler - Class in org.spdx.licenseTemplate

License template output handler for generating an HTML version of a license from a license template.

HtmlTemplateOutputHandler() - Constructor for class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

htmlToText(String) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Converts an HTML string to text preserving line breaks for <br/> tags

I

idPrefix - Variable in class org.spdx.core.CoreModelObject

IExternalElementInfo - Interface in org.spdx.core

Information about an Element which is external to the collection or store

ILicenseTemplateOutputHandler - Interface in org.spdx.licenseTemplate

Handles output for parsed license templates

IModelCopyManager - Interface in org.spdx.core

Implementation classes of this interface helps facilitate copying objects from one model to another.

IModelStore - Interface in org.spdx.storage

Service Provider Interface for storing and retrieving SPDX properties from the underlying store.

IModelStore.IdType - Enum in org.spdx.storage

Different types of ID's

IModelStore.IModelStoreLock - Interface in org.spdx.storage

IModelStore.ModelUpdate - Interface in org.spdx.storage

implementsIndividualUriValue(Class<?>) - Static method in class org.spdx.core.ModelObjectHelper

IndividualUriValue - Interface in org.spdx.core

Implementation classes of the IndividualUriValue stores a single URI value

inflateModelObject(IModelStore, String, String, IModelCopyManager, String, boolean, String) - Method in class org.spdx.core.ModelRegistry

If the object exists in the model store, it will be "inflated" back to the Java object.

initialize(IModelStore, String, IModelCopyManager) - Static method in class org.spdx.core.DefaultModelStore

Initialize the default model store.

InvalidLicenseTemplateException - Exception in org.spdx.licenseTemplate

Exceptions related to invalid license templates

InvalidLicenseTemplateException() - Constructor for exception org.spdx.licenseTemplate.InvalidLicenseTemplateException

InvalidLicenseTemplateException(String) - Constructor for exception org.spdx.licenseTemplate.InvalidLicenseTemplateException

InvalidLicenseTemplateException(String, Throwable) - Constructor for exception org.spdx.licenseTemplate.InvalidLicenseTemplateException

InvalidLicenseTemplateException(Throwable) - Constructor for exception org.spdx.licenseTemplate.InvalidLicenseTemplateException

InvalidSPDXAnalysisException - Exception in org.spdx.core

Exception for invalid SPDX Documents

InvalidSPDXAnalysisException() - Constructor for exception org.spdx.core.InvalidSPDXAnalysisException

InvalidSPDXAnalysisException(String) - Constructor for exception org.spdx.core.InvalidSPDXAnalysisException

InvalidSPDXAnalysisException(String, Throwable) - Constructor for exception org.spdx.core.InvalidSPDXAnalysisException

InvalidSPDXAnalysisException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.InvalidSPDXAnalysisException

InvalidSPDXAnalysisException(Throwable) - Constructor for exception org.spdx.core.InvalidSPDXAnalysisException

InvalidSpdxPropertyException - Exception in org.spdx.core

Invalid property name or value for an SPDX item

InvalidSpdxPropertyException() - Constructor for exception org.spdx.core.InvalidSpdxPropertyException

InvalidSpdxPropertyException(String) - Constructor for exception org.spdx.core.InvalidSpdxPropertyException

InvalidSpdxPropertyException(String, Throwable) - Constructor for exception org.spdx.core.InvalidSpdxPropertyException

InvalidSpdxPropertyException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.InvalidSpdxPropertyException

InvalidSpdxPropertyException(Throwable) - Constructor for exception org.spdx.core.InvalidSpdxPropertyException

isAnon(String) - Method in interface org.spdx.storage.IModelStore

isAnon(String) - Method in class org.spdx.storage.NullModelStore

isCollectionMembersAssignableTo(String, PropertyDescriptor, Class<?>) - Method in interface org.spdx.storage.IModelStore

isCollectionMembersAssignableTo(String, PropertyDescriptor, Class<?>) - Method in class org.spdx.storage.NullModelStore

isCollectionMembersAssignableTo(PropertyDescriptor, Class<?>) - Method in class org.spdx.core.CoreModelObject

isCollectionProperty(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

isCollectionProperty(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

isEmpty() - Method in class org.spdx.core.ModelCollection

isEquivalentToNull(Object, PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

ISerializableModelStore - Interface in org.spdx.storage

A model store that can be serialized and de-serialized to and from a Stream

isExternal() - Method in class org.spdx.core.CoreModelObject

NOTE: Subclasses the represent model object not stored in the modelStore should override this method and set it to true

isIndividualUriValueEquals(IndividualUriValue, Object) - Static method in class org.spdx.core.SimpleUriValue

Compares an object to an individual URI and returns true if the URI values are equal

isInitialized() - Static method in class org.spdx.core.DefaultModelStore

Checks if the default model store is initialized

isLicenseTextEquivalent(String, String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Returns true if two sets of license text is considered a match per the SPDX License matching guidelines documented at spdx.org (currently license matching guidelines) There are 2 unimplemented features - bullets/numbering is not considered and comments with no whitespace between text is not skipped

isNoAssertion(Object) - Method in class org.spdx.core.CoreModelObject

ISpdxModelInfo - Interface in org.spdx.core

Interface for SPDX model information

isPropertyValueAssignableTo(String, PropertyDescriptor, Class<?>, String) - Method in interface org.spdx.storage.IModelStore

isPropertyValueAssignableTo(String, PropertyDescriptor, Class<?>, String) - Method in class org.spdx.storage.NullModelStore

isRelatedElement(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

isStrict() - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

isStrict() - Method in class org.spdx.core.CoreModelObject

iterator() - Method in class org.spdx.core.ModelCollection

L

latestVersion() - Static method in enum org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

Returns the latest major version of the SPDX specification.

leaveCriticalSection(IModelStore.IModelStoreLock) - Method in class org.spdx.core.CoreModelObject

Leave a critical section.

leaveCriticalSection(IModelStore.IModelStoreLock) - Method in interface org.spdx.storage.IModelStore

Leave a critical section.

leaveCriticalSection(IModelStore.IModelStoreLock) - Method in class org.spdx.storage.NullModelStore

LicenseParserException - Exception in org.spdx.licenseTemplate

Exception caused by an invalid license expression

LicenseParserException(String) - Constructor for exception org.spdx.licenseTemplate.LicenseParserException

LicenseParserException(String, Throwable) - Constructor for exception org.spdx.licenseTemplate.LicenseParserException

LicenseRef - org.spdx.storage.IModelStore.IdType

LicenseTemplateRule - Class in org.spdx.licenseTemplate

Implements a license rule

LicenseTemplateRule(String) - Constructor for class org.spdx.licenseTemplate.LicenseTemplateRule

Create a new License Template Rule by parsing a rule string compliant with the SPDX License Template text

LicenseTemplateRule(String, LicenseTemplateRule.RuleType) - Constructor for class org.spdx.licenseTemplate.LicenseTemplateRule

LicenseTemplateRule(String, LicenseTemplateRule.RuleType, String, String, String) - Constructor for class org.spdx.licenseTemplate.LicenseTemplateRule

Create a new LicenseTemplateRule

LicenseTemplateRule.RuleType - Enum in org.spdx.licenseTemplate

LicenseTemplateRuleException - Exception in org.spdx.licenseTemplate

Exception for license template rules

LicenseTemplateRuleException(String) - Constructor for exception org.spdx.licenseTemplate.LicenseTemplateRuleException

LicenseTemplateRuleException(String, Throwable) - Constructor for exception org.spdx.licenseTemplate.LicenseTemplateRuleException

LicenseTextHelper - Class in org.spdx.licenseTemplate

Static helper class for comparing license text

LineColumn - Class in org.spdx.licenseTemplate

Holds information on lines and columns

LineColumn(int, int, int) - Constructor for class org.spdx.licenseTemplate.LineColumn

LISTED_LICENSE_NAMESPACE_PREFIX - Static variable in class org.spdx.core.SpdxCoreConstants

The namespace prefix for the SPDX Listed Licenses.

LISTED_LICENSE_URL - Static variable in class org.spdx.core.SpdxCoreConstants

The URL for the SPDX Listed Licenses.

ListedLicense - org.spdx.storage.IModelStore.IdType

listValues(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

listValues(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

M

MISSING_PROPERTY - org.spdx.core.NotEquivalentReason.NotEquivalent

Indicates that a property is missing in one of the objects.

modelClassToStoredClass(Class<?>) - Static method in class org.spdx.core.ModelObjectHelper

Convert the class to the appropriate stored class

ModelCollection<T> - Class in org.spdx.core

Collection of elements stored in a ModelStore

ModelCollection(IModelStore, String, PropertyDescriptor, IModelCopyManager, Class<?>, String, String) - Constructor for class org.spdx.core.ModelCollection

ModelObjectHelper - Class in org.spdx.core

A set of static methods to help with common ModelObject functions

modelObjectToStoredObject(Object, IModelStore, IModelCopyManager, String) - Static method in class org.spdx.core.ModelObjectHelper

Converts a model object to the object to be stored

ModelRegistry - Class in org.spdx.core

Singleton class which contains a registry of SPDX model versions

ModelRegistryException - Exception in org.spdx.core

Exceptions related to a model registry

ModelRegistryException() - Constructor for exception org.spdx.core.ModelRegistryException

ModelRegistryException(String) - Constructor for exception org.spdx.core.ModelRegistryException

ModelRegistryException(String, Throwable) - Constructor for exception org.spdx.core.ModelRegistryException

ModelRegistryException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.ModelRegistryException

ModelRegistryException(Throwable) - Constructor for exception org.spdx.core.ModelRegistryException

ModelSet<T> - Class in org.spdx.core

A ModelCollection implemented as a set where all items in the collection are unique based on equality (not based on equivalence).

ModelSet(IModelStore, String, PropertyDescriptor, IModelCopyManager, Class<?>, String, String) - Constructor for class org.spdx.core.ModelSet

modelStore - Variable in class org.spdx.core.CoreModelObject

N

NORMALIZE_TOKENS - Static variable in class org.spdx.licenseTemplate.LicenseTextHelper

normalizeText(String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Normalize quotes and no-break spaces

NotEquivalentReason - Class in org.spdx.core

Records details when two model objects are compared and are determined to not be equivalent

NotEquivalentReason(NotEquivalentReason.NotEquivalent) - Constructor for class org.spdx.core.NotEquivalentReason

Constructs a NotEquivalentReason with the specified reason.

NotEquivalentReason(NotEquivalentReason.NotEquivalent, PropertyDescriptor) - Constructor for class org.spdx.core.NotEquivalentReason

Constructs a NotEquivalentReason with the specified reason and property.

NotEquivalentReason.NotEquivalent - Enum in org.spdx.core

Enum representing the reasons why two model objects are not equivalent.

NullModelStore - Class in org.spdx.storage

Null model store to be used with constants and individuals

NullModelStore() - Constructor for class org.spdx.storage.NullModelStore

O

objectUri - Variable in class org.spdx.core.CoreModelObject

OPTIONAL_LICENSE_TEXT_CLASS - Static variable in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

optionalStoredObjectToModelObject(Optional<Object>, IModelStore, IModelCopyManager, String, Class<?>, String) - Static method in class org.spdx.core.ModelObjectHelper

Converts any typed value or IndividualValue objects to a ModelObject, returning an existing ModelObject if it exists or creates a new ModelObject

org.spdx.core - package org.spdx.core

Common classes used by the SPDX model and library

org.spdx.licenseTemplate - package org.spdx.licenseTemplate

License template are used for matching licenses

org.spdx.storage - package org.spdx.storage

Classes that implement the storage interfaces for reading and writing SPDX document properties

P

parseLicenseTemplateRule(String) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

Parse a license template rule string compliant with the SPDX license template text and replace all properties with the parsed values

parseTemplate(String, ILicenseTemplateOutputHandler) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Parses the license template calling the templateOutputHandler for any text and rules found

PROPERTY_NOT_EQUIVALENT - org.spdx.core.NotEquivalentReason.NotEquivalent

Indicates that a property value is not equivalent between the objects.

PropertyDescriptor - Class in org.spdx.storage

Holds a description of a property including the property name and property nameSpace

PropertyDescriptor(String, String) - Constructor for class org.spdx.storage.PropertyDescriptor

PUNCTUATION - Static variable in class org.spdx.licenseTemplate.LicenseTextHelper

putCopiedId(IModelStore, String, IModelStore, String) - Method in interface org.spdx.core.IModelCopyManager

Record a copied ID between model stores

R

registerModel(ISpdxModelInfo) - Method in class org.spdx.core.ModelRegistry

remove(Object) - Method in class org.spdx.core.ModelCollection

removeAll(Collection<?>) - Method in class org.spdx.core.ModelCollection

removeLineSeparators(String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

removeProperty(String, PropertyDescriptor) - Method in interface org.spdx.storage.IModelStore

Removes a property from the document for the given ID if the property exists.

removeProperty(String, PropertyDescriptor) - Method in class org.spdx.storage.NullModelStore

removeProperty(IModelStore, String, PropertyDescriptor) - Static method in class org.spdx.core.ModelObjectHelper

Removes a property and its value from the model store if it exists

removeProperty(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

Removes a property and its value from the model store if it exists

removePropertyValueFromCollection(IModelStore, String, PropertyDescriptor, Object) - Static method in class org.spdx.core.ModelObjectHelper

Remove a property value from a collection

removePropertyValueFromCollection(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Remove a property value from a collection

removeValueFromCollection(String, PropertyDescriptor, Object) - Method in interface org.spdx.storage.IModelStore

Removes a value from a collection of values associated with a property

removeValueFromCollection(String, PropertyDescriptor, Object) - Method in class org.spdx.storage.NullModelStore

REPLACEABLE_LICENSE_TEXT_CLASS - Static variable in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

replaceMultWord(String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

replaces all multi-words with a single token using a dash to separate

replacePropertyValueCollection(IModelStore, String, PropertyDescriptor, Collection<?>, IModelCopyManager, String) - Static method in class org.spdx.core.ModelObjectHelper

Replace the entire value collection for a property.

replaceSpaceComma(String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Replace different forms of space with a normalized space and different forms of commas with a normalized comma

retainAll(Collection<?>) - Method in class org.spdx.core.ModelCollection

RULE_PATTERN - Static variable in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

RuntimeSpdxException - Exception in org.spdx.core

Runtime Exception wrapper for SPDX exceptions (cause field)

RuntimeSpdxException(String) - Constructor for exception org.spdx.core.RuntimeSpdxException

RuntimeSpdxException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.RuntimeSpdxException

RuntimeSpdxException(String, InvalidSPDXAnalysisException) - Constructor for exception org.spdx.core.RuntimeSpdxException

RuntimeSpdxException(InvalidSPDXAnalysisException) - Constructor for exception org.spdx.core.RuntimeSpdxException

S

serialize(OutputStream) - Method in interface org.spdx.storage.ISerializableModelStore

Serialize all the items stored in the model store

serialize(OutputStream, CoreModelObject) - Method in interface org.spdx.storage.ISerializableModelStore

Serialize the items stored in the model store

setColumn(int) - Method in class org.spdx.licenseTemplate.LineColumn

setCopyManager(IModelCopyManager) - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

setCopyManager(IModelCopyManager) - Method in class org.spdx.core.CoreModelObject

Set the copy manager

setExample(String) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

setIdPrefix(String) - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

setIdPrefix(String) - Method in class org.spdx.core.CoreModelObject

Sets the idPrefix

setLen(int) - Method in class org.spdx.licenseTemplate.LineColumn

setLine(int) - Method in class org.spdx.licenseTemplate.LineColumn

setMatch(String) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

setModelStore(IModelStore) - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

setName(String) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

setName(String) - Method in class org.spdx.storage.PropertyDescriptor

setNameSpace(String) - Method in class org.spdx.storage.PropertyDescriptor

setObjectUri(String) - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

setOriginal(String) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

setProperty(PropertyDescriptor) - Method in class org.spdx.core.NotEquivalentReason

setPropertyValue(IModelStore, String, PropertyDescriptor, Object, IModelCopyManager, String) - Static method in class org.spdx.core.ModelObjectHelper

Set a property value for a property descriptor, creating the property if necessary

setPropertyValue(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Set a property value for a property descriptor, creating the property if necessary

setReason(NotEquivalentReason.NotEquivalent) - Method in class org.spdx.core.NotEquivalentReason

setStrict(boolean) - Method in class org.spdx.core.CoreModelObject.CoreModelObjectBuilder

setStrict(boolean) - Method in class org.spdx.core.CoreModelObject

setType(LicenseTemplateRule.RuleType) - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

setValue(String, PropertyDescriptor, Object) - Method in interface org.spdx.storage.IModelStore

Sets a property value for a String or Boolean type of value creating the propertyDescriptor if it does not exist

setValue(String, PropertyDescriptor, Object) - Method in class org.spdx.storage.NullModelStore

SimpleUriValue - Class in org.spdx.core

Simple class to just store a URI value

SimpleUriValue(String) - Constructor for class org.spdx.core.SimpleUriValue

SimpleUriValue(IndividualUriValue) - Constructor for class org.spdx.core.SimpleUriValue

size() - Method in class org.spdx.core.ModelCollection

SKIPPABLE_TOKENS - Static variable in class org.spdx.licenseTemplate.LicenseTextHelper

SpdxCoreConstants - Class in org.spdx.core

Common constants used in the SPDX core library

SpdxCoreConstants() - Constructor for class org.spdx.core.SpdxCoreConstants

SpdxCoreConstants.SpdxMajorVersion - Enum in org.spdx.core

Enumeration representing the major versions of the SPDX specification

SpdxId - org.spdx.storage.IModelStore.IdType

SpdxIdInUseException - Exception in org.spdx.core

Exception when an SPDX element is in use (e.g.

SpdxIdInUseException() - Constructor for exception org.spdx.core.SpdxIdInUseException

SpdxIdInUseException(String) - Constructor for exception org.spdx.core.SpdxIdInUseException

SpdxIdInUseException(String, Throwable) - Constructor for exception org.spdx.core.SpdxIdInUseException

SpdxIdInUseException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.SpdxIdInUseException

SpdxIdInUseException(Throwable) - Constructor for exception org.spdx.core.SpdxIdInUseException

SpdxIdNotFoundException - Exception in org.spdx.core

Exception for no SPDX identifier found

SpdxIdNotFoundException() - Constructor for exception org.spdx.core.SpdxIdNotFoundException

General SPDX ID not found exception

SpdxIdNotFoundException(String) - Constructor for exception org.spdx.core.SpdxIdNotFoundException

SpdxIdNotFoundException(String, Throwable) - Constructor for exception org.spdx.core.SpdxIdNotFoundException

SpdxIdNotFoundException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.SpdxIdNotFoundException

SpdxIdNotFoundException(Throwable) - Constructor for exception org.spdx.core.SpdxIdNotFoundException

SpdxInvalidIdException - Exception in org.spdx.core

Invalid SPDX identifier

SpdxInvalidIdException() - Constructor for exception org.spdx.core.SpdxInvalidIdException

Invalid ID

SpdxInvalidIdException(String) - Constructor for exception org.spdx.core.SpdxInvalidIdException

SpdxInvalidIdException(String, Throwable) - Constructor for exception org.spdx.core.SpdxInvalidIdException

SpdxInvalidIdException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.SpdxInvalidIdException

SpdxInvalidIdException(Throwable) - Constructor for exception org.spdx.core.SpdxInvalidIdException

SpdxInvalidTypeException - Exception in org.spdx.core

Invalid type for an SPDX property

SpdxInvalidTypeException() - Constructor for exception org.spdx.core.SpdxInvalidTypeException

SpdxInvalidTypeException(String) - Constructor for exception org.spdx.core.SpdxInvalidTypeException

SpdxInvalidTypeException(String, Throwable) - Constructor for exception org.spdx.core.SpdxInvalidTypeException

SpdxInvalidTypeException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.SpdxInvalidTypeException

SpdxInvalidTypeException(Throwable) - Constructor for exception org.spdx.core.SpdxInvalidTypeException

SpdxLicenseTemplateHelper - Class in org.spdx.licenseTemplate

Implements common conversion methods for processing SPDX license templates

SpdxObjectNotInStoreException - Exception in org.spdx.core

Exception when an SPDX ID or object was not found in a model store

SpdxObjectNotInStoreException() - Constructor for exception org.spdx.core.SpdxObjectNotInStoreException

SpdxObjectNotInStoreException(String) - Constructor for exception org.spdx.core.SpdxObjectNotInStoreException

SpdxObjectNotInStoreException(String, Throwable) - Constructor for exception org.spdx.core.SpdxObjectNotInStoreException

SpdxObjectNotInStoreException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.core.SpdxObjectNotInStoreException

SpdxObjectNotInStoreException(Throwable) - Constructor for exception org.spdx.core.SpdxObjectNotInStoreException

specVersion - Variable in class org.spdx.core.CoreModelObject

storedObjectToModelObject(Object, IModelStore, IModelCopyManager, String, Class<?>, String) - Static method in class org.spdx.core.ModelObjectHelper

Converts any typed value or individual value objects to a ModelObject, returning an existing ModelObject if it exists or creates a new ModelObject

strict - Variable in class org.spdx.core.CoreModelObject

if true, checks input values for setters to verify valid SPDX inputs

T

templateTextToHtml(String) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Converts a license template string to formatted HTML which highlights any rules or tags

templateToText(String) - Static method in class org.spdx.licenseTemplate.SpdxLicenseTemplateHelper

Converts template text to standard default text using any default parameters in the rules

text(String) - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

text(String) - Method in interface org.spdx.licenseTemplate.ILicenseTemplateOutputHandler

Text for processing

text(String) - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

TextTemplateOutputHandler - Class in org.spdx.licenseTemplate

License template output handler for generating a text version of a license from a license template

TextTemplateOutputHandler() - Constructor for class org.spdx.licenseTemplate.TextTemplateOutputHandler

toArray() - Method in class org.spdx.core.ModelCollection

toArray(T1[]) - Method in class org.spdx.core.ModelCollection

toImmutableList() - Method in class org.spdx.core.ModelCollection

TOKEN_SPLIT_PATTERN - Static variable in class org.spdx.licenseTemplate.LicenseTextHelper

TOKEN_SPLIT_REGEX - Static variable in class org.spdx.licenseTemplate.LicenseTextHelper

tokenizeLicenseText(String, Map<Integer, LineColumn>) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Tokenizes the license text, normalizes quotes, lowercases and converts multi-words for better equiv.

tokensEquivalent(String, String) - Static method in class org.spdx.licenseTemplate.LicenseTextHelper

Returns true if the two tokens can be considered equivalent per the SPDX license matching rules

toModelObject(IModelStore, IModelCopyManager, String, Class<?>) - Method in class org.spdx.core.SimpleUriValue

inflate the value back to either an Enum (if the URI matches), an Individual (if the URI matches), the modelObject (if the store contains the object matching the URI), or an ExternalObject if not in the store

toString() - Method in class org.spdx.core.CoreModelObject

toString() - Method in class org.spdx.core.TypedValue

toString() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

toString() - Method in class org.spdx.storage.PropertyDescriptor

toTypedValue() - Method in class org.spdx.core.CoreModelObject

TypedValue - Class in org.spdx.core

Value which is a stored typed item

TypedValue(String, String, String) - Constructor for class org.spdx.core.TypedValue

Constructs a TypedValue with the specified object URI, type, and spec version.

typeToClass(String, String) - Method in class org.spdx.core.ModelRegistry

U

Unknown - org.spdx.storage.IModelStore.IdType

Unkown - org.spdx.storage.IModelStore.IdType

Deprecated.

unlock() - Method in interface org.spdx.storage.IModelStore.IModelStoreLock

updateAddPropertyValueToCollection(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Create an update when, when applied, adds a value to a collection of values associated with a property.

updateClearValueCollection(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

Create an update when, when applied by the ModelStore, clears a collection of values associated with a property

updatePropertyValue(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Create an update when, when applied by the ModelStore, sets a property value for a property descriptor, creating the property if necessary

updateRemoveProperty(PropertyDescriptor) - Method in class org.spdx.core.CoreModelObject

Create an update when, when applied by the ModelStore, removes a property and its value from the model store if it exists

updateRemovePropertyValueFromCollection(PropertyDescriptor, Object) - Method in class org.spdx.core.CoreModelObject

Create an update when, when applied, removes a property value from a collection

uriToEnum(String, String) - Method in class org.spdx.core.ModelRegistry

Converts a URI to enum

uriToIndividual(String, Class<?>) - Method in interface org.spdx.core.ISpdxModelInfo

uriToIndividual(String, String, Class<?>) - Method in class org.spdx.core.ModelRegistry

V

validate() - Method in class org.spdx.licenseTemplate.LicenseTemplateRule

Validates that the LicenseTemplateRule is properly initialized

valueOf(String) - Static method in enum org.spdx.core.NotEquivalentReason.NotEquivalent

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.spdx.licenseTemplate.LicenseTemplateRule.RuleType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.spdx.storage.IModelStore.IdType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.spdx.core.NotEquivalentReason.NotEquivalent

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.spdx.licenseTemplate.LicenseTemplateRule.RuleType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.spdx.storage.IModelStore.IdType

Returns an array containing the constants of this enum type, in the order they are declared.

VARIABLE - org.spdx.licenseTemplate.LicenseTemplateRule.RuleType

variableRule(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.HtmlTemplateOutputHandler

variableRule(LicenseTemplateRule) - Method in interface org.spdx.licenseTemplate.ILicenseTemplateOutputHandler

Variable rule found within the template

variableRule(LicenseTemplateRule) - Method in class org.spdx.licenseTemplate.TextTemplateOutputHandler

verify() - Method in class org.spdx.core.CoreModelObject

verify(String) - Method in class org.spdx.core.CoreModelObject

verify(Set<String>, String) - Method in class org.spdx.core.CoreModelObject

verifyCollection(Collection<? extends CoreModelObject>, String, Set<String>, String) - Method in class org.spdx.core.CoreModelObject

Verifies all elements in a collection

verifyCollection(Collection<? extends CoreModelObject>, String, Set<String>, String) - Static method in class org.spdx.core.ModelObjectHelper

Verifies all elements in a collection

VERSION_1 - org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

SPDX version 1.x

VERSION_2 - org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

SPDX version 2.x

VERSION_3 - org.spdx.core.SpdxCoreConstants.SpdxMajorVersion

SPDX version 3.x

_

_verify(Set<String>, String, List<IndividualUriValue>) - Method in class org.spdx.core.CoreModelObject

Implementation of the specific verifications for this model object

A B C D E F G H I L M N O P R S T U V _
All Classes All Packages