java.lang.Object

org.spdx.rdfparser.license.LicenseException

All Implemented Interfaces:: Cloneable, IRdfModel

Direct Known Subclasses:: ListedLicenseException

public class LicenseException
extends Object
implements IRdfModel, Cloneable

Represents an SPDX license exception as defined in the License Expression Language Used with the "with" unary expression.

Author:: Gary O'Neall

Constructor Summary

Constructors
Constructor	Description
`LicenseException()`
`LicenseException(String exceptionId)`
`LicenseException(String licenseExceptionId, String name, String licenseExceptionText)`
`LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String[] seeAlso, String comment)`
`LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String[] seeAlso, String comment, String example)`	Deprecated.
`LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String licenseExceptionTemplate, String[] seeAlso, String comment)`
`LicenseException(IModelContainer modelContainer, org.apache.jena.graph.Node node)`

Method Summary

Modifier and Type	Method	Description
`LicenseException`	`clone()`
`void`	`copyFrom(LicenseException exception)`	Copy all of the parameters from another license
`org.apache.jena.rdf.model.Resource`	`createResource(IModelContainer modelContainer)`	If a resource does not already exist in this model for this object, create a new resource and populate it.
`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
`static org.apache.jena.graph.Node`	`findException(org.apache.jena.rdf.model.Model model, String id)`	Searches the model for a exception with the ID
`String`	`getComment()`
`String`	`getExample()`	Deprecated.
`static String`	`getExceptionTextFromModel(org.apache.jena.rdf.model.Model model, org.apache.jena.graph.Node exceptionNode)`	Get the exception text from the model
`String`	`getLicenseExceptionId()`
`String`	`getLicenseExceptionTemplate()`
`String`	`getLicenseExceptionText()`
`String`	`getName()`
`String[]`	`getSeeAlso()`
`protected String`	`getUri(IModelContainer modelContainer)`
`int`	`hashCode()`
`boolean`	`isDeprecated()`
`void`	`setComment(String comment)`
`void`	`setDeprecated(boolean deprecated)`
`void`	`setExample(String example)`	Deprecated.
`void`	`setLicenseExceptionId(String id)`
`void`	`setLicenseExceptionTemplate(String template)`
`void`	`setLicenseExceptionText(String text)`
`void`	`setMultipleObjectsForSameNode()`	Called to signal that there are multiple objects representing the same node
`void`	`setName(String name)`
`void`	`setSeeAlso(String[] url)`
`void`	`setSingleObjectForSameNode()`	Called to signal that a newly created resource is only used for a single node
`String`	`toString()`
`List<String>`	`verify()`

Methods inherited from class java.lang.Object

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

Constructor Details
- LicenseException
  
  public LicenseException(IModelContainer modelContainer, org.apache.jena.graph.Node node) throws InvalidSPDXAnalysisException
  
  Throws:
  
  InvalidSPDXAnalysisException
- LicenseException
  
  @Deprecated public LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String[] seeAlso, String comment, String example)
  
  Deprecated.
  
  The example field is no longer used, please use the constructor without th example
  
  Parameters:
  
  licenseExceptionId - Exception ID - short form ID
  
  name - Full name of the Exception
  
  licenseExceptionText - Text for the Exception
  
  comment - Comments on the exception
  
  example - Example of use
  
  seeAlso - URL references to external sources for the exception
- LicenseException
  
  public LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String[] seeAlso, String comment)
  
  Parameters:
  
  licenseExceptionId - Exception ID - short form ID
  
  name - Full name of the Exception
  
  licenseExceptionText - Text for the Exception
  
  comment - Comments on the exception
  
  example - Example of use
  
  seeAlso - URL references to external sources for the exception
- LicenseException
  
  public LicenseException(String licenseExceptionId, String name, String licenseExceptionText, String licenseExceptionTemplate, String[] seeAlso, String comment)
  
  Parameters:
  
  licenseExceptionId - Exception ID - short form ID
  
  name - Full name of the Exception
  
  licenseExceptionText - Text for the Exception
  
  licenseExceptionTemplate - License exception template use for matching license exceptions per SPDX license matching guidelines
  
  comment - Comments on the exception
  
  seeAlso - URL references to external sources for the exception
- LicenseException
  
  public LicenseException(String licenseExceptionId, String name, String licenseExceptionText)
  
  Parameters:
  
  licenseExceptionId - Exception ID - short form ID
  
  name - Full name of the Exception
  
  licenseExceptionText - Text for the Exception
- LicenseException
  
  public LicenseException()
- LicenseException
  
  public LicenseException(String exceptionId)
  
  Parameters:
  
  token -
Method Details
- createResource
  
  public org.apache.jena.rdf.model.Resource createResource(IModelContainer modelContainer) throws InvalidSPDXAnalysisException
  
  If a resource does not already exist in this model for this object, create a new resource and populate it. If the resource does exist, return the existing resource.
  
  Specified by:
  
  createResource in interface IRdfModel
  
  Parameters:
  
  model -
  
  Returns:
  
  resource created from the model
  
  Throws:
  
  InvalidSPDXAnalysisException
- getExceptionTextFromModel
  
  public static String getExceptionTextFromModel(org.apache.jena.rdf.model.Model model, org.apache.jena.graph.Node exceptionNode)
  
  Get the exception text from the model
  
  Parameters:
  
  model -
  
  exceptionNode -
  
  Returns:
- findException
  
  public static org.apache.jena.graph.Node findException(org.apache.jena.rdf.model.Model model, String id)
  
  Searches the model for a exception with the ID
  
  Parameters:
  
  model -
  
  id -
  
  Returns:
  
  Node containing the exception or Null if none found
- getLicenseExceptionId
  
  public String getLicenseExceptionId()
  
  Returns:
  
  the id
- setLicenseExceptionId
  
  public void setLicenseExceptionId(String id) throws InvalidSPDXAnalysisException
  
  Parameters:
  
  id - the id to set
  
  Throws:
  
  InvalidSPDXAnalysisException
- getName
  
  public String getName()
  
  Returns:
  
  the name
- setName
  
  public void setName(String name)
  
  Parameters:
  
  name - the name to set
- getLicenseExceptionText
  
  public String getLicenseExceptionText()
  
  Returns:
  
  the text
- setLicenseExceptionText
  
  public void setLicenseExceptionText(String text)
  
  Parameters:
  
  text - the text to set
- getLicenseExceptionTemplate
  
  public String getLicenseExceptionTemplate()
  
  Returns:
  
  the tempalte
- setLicenseExceptionTemplate
  
  public void setLicenseExceptionTemplate(String template)
  
  Parameters:
  
  template - the text to set
- getSeeAlso
  
  public String[] getSeeAlso()
  
  Returns:
  
  the sourceUrl
- setSeeAlso
  
  public void setSeeAlso(String[] url)
  
  Parameters:
  
  url - the sourceUrl to set
- getComment
  
  public String getComment()
  
  Returns:
- setComment
  
  public void setComment(String comment)
- getExample
  
  @Deprecated public String getExample()
  
  Deprecated.
  
  Returns:
- setExample
  
  @Deprecated public void setExample(String example)
  
  Deprecated.
- clone
  
  public LicenseException clone()
  
  Overrides:
  
  clone in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- verify
  
  public List<String> verify()
  
  Specified by:
  
  verify in interface IRdfModel
  
  Returns:
  
  List of validation errors for any non SPDX compliant properties.
- 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
  
  Returns:
- setMultipleObjectsForSameNode
  
  public void setMultipleObjectsForSameNode()
  
  Description copied from interface: IRdfModel
  
  Called to signal that there are multiple objects representing the same node
  
  Specified by:
  
  setMultipleObjectsForSameNode in interface IRdfModel
- setSingleObjectForSameNode
  
  public void setSingleObjectForSameNode()
  
  Description copied from interface: IRdfModel
  
  Called to signal that a newly created resource is only used for a single node
  
  Specified by:
  
  setSingleObjectForSameNode in interface IRdfModel
- isDeprecated
  
  public boolean isDeprecated()
  
  Returns:
  
  true if this license is marked as being deprecated
- setDeprecated
  
  public void setDeprecated(boolean deprecated)
  
  Parameters:
  
  deprecated - true if this license is deprecated
- copyFrom
  
  public void copyFrom(LicenseException exception) throws InvalidSPDXAnalysisException
  
  Copy all of the parameters from another license
  
  Parameters:
  
  exception -
  
  Throws:
  
  InvalidSPDXAnalysisException
- getUri
  
  protected String getUri(IModelContainer modelContainer) throws InvalidSPDXAnalysisException
  
  Throws:
  
  InvalidSPDXAnalysisException

Class LicenseException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details