Package org.spdx.licensexml

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 String	LICENSE_XML_SCHEMA_LOCATION
static String	LICENSE_XML_SCHEMA_URL
static String	PROP_SCHEMA_FILENAME

Constructor Summary

Constructors

Constructor	Description
LicenseXmlDocument(File file)
LicenseXmlDocument(Document xmlDocument)

Method Summary

Modifier and Type	Method	Description
List<org.spdx.library.model.license.ListedLicenseException>	getLicenseExceptions()
List<org.spdx.library.model.license.SpdxListedLicense>	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) throws LicenseXmlException

Parameters:

file - XML file for the License

Throws:

LicenseXmlException

LicenseXmlDocument

public LicenseXmlDocument(Document xmlDocument) throws LicenseXmlException

Throws:

LicenseXmlException

Method Details

getListedLicenses

public List<org.spdx.library.model.license.SpdxListedLicense> getListedLicenses() throws org.spdx.library.InvalidSPDXAnalysisException, LicenseXmlException

Will skip deprecated licenses

Returns:

Throws:

org.spdx.library.InvalidSPDXAnalysisException

LicenseXmlException

getLicenseExceptions

public List<org.spdx.library.model.license.ListedLicenseException> getLicenseExceptions() throws LicenseXmlException, org.spdx.library.InvalidSPDXAnalysisException

Returns:

Throws:

LicenseXmlException

org.spdx.library.InvalidSPDXAnalysisException