Class LicenseXmlDocument

java.lang.Object

org.spdx.licensexml.LicenseXmlDocument

public class LicenseXmlDocument
extends Object

Parses and provides access to a License XML document

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LICENSE_XML_SCHEMA_LOCATION
static final String	LICENSE_XML_SCHEMA_URL
static final String	PROP_SCHEMA_FILENAME

Constructor Summary

Constructors

Constructor	Description
LicenseXmlDocument(File file, org.spdx.storage.IModelStore v2ModelStore, org.spdx.storage.IModelStore v3ModelStore, org.spdx.core.IModelCopyManager copyManager, org.spdx.library.model.v3_0_1.core.CreationInfo creationInfo)
LicenseXmlDocument(Document xmlDocument)

Method Summary

Modifier and Type	Method	Description
List<ListedExceptionContainer>	getLicenseExceptions()
List<ListedLicenseContainer>	getListedLicenses()	Will skip deprecated licenses

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROP_SCHEMA_FILENAME

public static final String PROP_SCHEMA_FILENAME

See Also:

• Constant Field Values

LICENSE_XML_SCHEMA_URL

public static final String LICENSE_XML_SCHEMA_URL

See Also:

• Constant Field Values

LICENSE_XML_SCHEMA_LOCATION

public static final String LICENSE_XML_SCHEMA_LOCATION

See Also:

• Constant Field Values

Constructor Details

LicenseXmlDocument

public LicenseXmlDocument(File file,
 org.spdx.storage.IModelStore v2ModelStore,
 org.spdx.storage.IModelStore v3ModelStore,
 org.spdx.core.IModelCopyManager copyManager,
 org.spdx.library.model.v3_0_1.core.CreationInfo creationInfo)
                   throws LicenseXmlException

Parameters:

file - XML file for the License

v2ModelStore - model store for SPDX Spec version 2 license and exceptions

v3ModelStore - model store for SPDX Spec version 3 license and exceptions

copyManager - Copy manager for both model store

creationInfo - Creation information to use for SPDX V3 licenses and exceptions

copyManager - copyManager to use for copying data between model stores

currentListVersion - version of the license list to include the license data

releaseDate - Date the license list is released

Throws:

LicenseXmlException

LicenseXmlDocument

public LicenseXmlDocument(Document xmlDocument)
                   throws LicenseXmlException

Throws:

LicenseXmlException

Method Details

getListedLicenses

public List<ListedLicenseContainer> getListedLicenses()
                                               throws org.spdx.core.InvalidSPDXAnalysisException,
LicenseXmlException

Will skip deprecated licenses

Returns:

Throws:

org.spdx.core.InvalidSPDXAnalysisException

LicenseXmlException

getLicenseExceptions

public List<ListedExceptionContainer> getLicenseExceptions()
                                                    throws LicenseXmlException,
org.spdx.core.InvalidSPDXAnalysisException

Returns:

Throws:

LicenseXmlException

org.spdx.core.InvalidSPDXAnalysisException