org.spdx.rdfparser.license

Class License

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.license.AnyLicenseInfo

org.spdx.rdfparser.license.SimpleLicensingInfo

org.spdx.rdfparser.license.License

All Implemented Interfaces:

Cloneable, IRdfModel

Direct Known Subclasses:

SpdxListedLicense

public abstract class License
extends SimpleLicensingInfo

Describes a license All licenses have an ID. Subclasses should extend this class to add additional properties.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
protected String	licenseText
protected boolean	osiApproved
protected String	standardLicenseHeader
protected String	standardLicenseTemplate

Fields inherited from class org.spdx.rdfparser.license.SimpleLicensingInfo

comment, licenseId, name, seeAlso

Fields inherited from class org.spdx.rdfparser.model.RdfModelObject

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
License(IModelContainer modelContainer, org.apache.jena.graph.Node licenseNode) Constructs an SPDX License from the licenseNode
License(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved)

Method Summary

Modifier and Type	Method and Description
AnyLicenseInfo	clone()
void	copyFrom(License license) Copy all of the parameters from another license
boolean	equals(Object o)
boolean	equivalent(IRdfModel compare) Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model
String	getLicenseText()
String	getNotes() Deprecated.
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
String	getStandardLicenseHeader()
String	getStandardLicenseTemplate()
int	hashCode()
boolean	isOsiApproved()
void	populateModel() Populate the RDF model from the Java properties
void	setLicenseText(String text)
void	setNotes(String notes) Deprecated.
void	setOsiApproved(boolean osiApproved)
void	setStandardLicenseHeader(String standardLicenseHeader)
void	setStandardLicenseTemplate(String template)
String	toString()
List<String>	verify()

Methods inherited from class org.spdx.rdfparser.license.SimpleLicensingInfo

findDuplicateResource, getComment, getLicenseId, getName, getSeeAlso, getUri, setComment, setLicenseId, setName, setSeeAlso

Methods inherited from class org.spdx.rdfparser.license.AnyLicenseInfo

getResource

Methods inherited from class org.spdx.rdfparser.model.RdfModelObject

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, equivalentConsideringNull, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findExternalRefPropertyValues, findIntPropertyValue, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findReferenceTypePropertyValue, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePointerPropertyValue, findSinglePropertyValue, findStartEndPointerPropertyValues, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, getType, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setSingleObjectForSameNode

Methods inherited from class java.lang.Object

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

Field Detail

standardLicenseHeader

protected String standardLicenseHeader

standardLicenseTemplate

protected String standardLicenseTemplate

licenseText

protected String licenseText

osiApproved

protected boolean osiApproved

Constructor Detail

License

public License(String name,
               String id,
               String text,
               String[] sourceUrl,
               String comments,
               String standardLicenseHeader,
               String template,
               boolean osiApproved)
        throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approvied license

Throws:

InvalidSPDXAnalysisException

License

public License(IModelContainer modelContainer,
               org.apache.jena.graph.Node licenseNode)
        throws InvalidSPDXAnalysisException

Constructs an SPDX License from the licenseNode

Parameters:

modelContainer - container which includes the license

licenseNode - RDF graph node representing the SPDX License

Throws:

InvalidSPDXAnalysisException

Method Detail

getPropertiesFromModel

public void getPropertiesFromModel()
                            throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Fetch all of the properties from the model and populate the local Java properties

Overrides:

getPropertiesFromModel in class SimpleLicensingInfo

Throws:

InvalidSPDXAnalysisException

populateModel

public void populateModel()
                   throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Populate the RDF model from the Java properties

Overrides:

populateModel in class SimpleLicensingInfo

Throws:

InvalidSPDXAnalysisException

getLicenseText

public String getLicenseText()

Returns:

the text of the license

setLicenseText

public void setLicenseText(String text)

Parameters:

text - the license text to set

getNotes

@Deprecated
public String getNotes()

Deprecated.

setNotes

@Deprecated
public void setNotes(String notes)

Deprecated.

getStandardLicenseHeader

public String getStandardLicenseHeader()

Returns:

the standardLicenseHeader

setStandardLicenseHeader

public void setStandardLicenseHeader(String standardLicenseHeader)

Parameters:

standardLicenseHeader - the standardLicenseHeader to set

getStandardLicenseTemplate

public String getStandardLicenseTemplate()

Returns:

the template

setStandardLicenseTemplate

public void setStandardLicenseTemplate(String template)

Parameters:

template - the template to set

toString

public String toString()

Specified by:

toString in class AnyLicenseInfo

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleLicensingInfo

equals

public boolean equals(Object o)

Overrides:

equals in class SimpleLicensingInfo

verify

public List<String> verify()

Returns:

List of validation errors for any non SPDX compliant properties.

isOsiApproved

public boolean isOsiApproved()

Returns:

true if the license is listed as an approved license on the OSI website

setOsiApproved

public void setOsiApproved(boolean osiApproved)

clone

public AnyLicenseInfo clone()

Specified by:

clone in class AnyLicenseInfo

copyFrom

public void copyFrom(License license)

Copy all of the parameters from another license

Parameters:

license -

equivalent

public boolean equivalent(IRdfModel compare)

Description copied from interface: IRdfModel

Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model

Specified by:

equivalent in interface IRdfModel

Overrides:

equivalent in class SimpleLicensingInfo

Parameters:

compare -

Returns: