Package org.spdx.library.model.v2

Class SpdxCreatorInformation

java.lang.Object

org.spdx.core.CoreModelObject

org.spdx.library.model.v2.ModelObjectV2

org.spdx.library.model.v2.SpdxCreatorInformation

public class SpdxCreatorInformation
extends ModelObjectV2

Provides the necessary information for forward and backward compatibility for processing tools.

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
SpdxCreatorInformation()
SpdxCreatorInformation(String id)
SpdxCreatorInformation(org.spdx.storage.IModelStore modelStore, String documentUri, String id, org.spdx.core.IModelCopyManager 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
Optional<String>	getComment()
String	getCreated()
Collection<String>	getCreators()
Optional<String>	getLicenseListVersion()
String	getType()
SpdxCreatorInformation	setComment(String comment)
SpdxCreatorInformation	setCreated(String created)
SpdxCreatorInformation	setLicenseListVersion(String licenseListVersion)
String	toString()

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

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

SpdxCreatorInformation

public SpdxCreatorInformation()
                       throws org.spdx.core.InvalidSPDXAnalysisException

Throws:

org.spdx.core.InvalidSPDXAnalysisException

SpdxCreatorInformation

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

Parameters:

id - identifier

Throws:

org.spdx.core.InvalidSPDXAnalysisException

SpdxCreatorInformation

public SpdxCreatorInformation(org.spdx.storage.IModelStore modelStore,
                              String documentUri,
                              String id,
                              org.spdx.core.IModelCopyManager copyManager,
                              boolean create)
                       throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

modelStore - container which includes the model data

documentUri - URI for the SPDX document containing the model data

id - identifier

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

getCreators

public Collection<String> getCreators()
                               throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

Creators Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name.

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getLicenseListVersion

public Optional<String> getLicenseListVersion()
                                       throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

An optional field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created.

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setLicenseListVersion

public SpdxCreatorInformation setLicenseListVersion(String licenseListVersion)
                                             throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

licenseListVersion - An optional field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created.

Returns:

this for building more options

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getComment

public Optional<String> getComment()
                            throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the comment

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setComment

public SpdxCreatorInformation setComment(String comment)
                                  throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

comment -

Returns:

this for building more options

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getCreated

public String getCreated()
                  throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

When the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard.

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setCreated

public SpdxCreatorInformation setCreated(String created)
                                  throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

created - When the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard.

Returns:

this for building more options

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getType

public String getType()

Specified by:

getType in class org.spdx.core.CoreModelObject

toString

public String toString()

Overrides:

toString in class ModelObjectV2

_verify

protected List<String> _verify(Set<String> verifiedIds,
                               String specVersion)

Description copied from class: ModelObjectV2

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObjectV2

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