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 and Description
static String	LICENSE_XML_SCHEMA_LOCATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<SPDXLicenseSpreadsheet.DeprecatedLicenseInfo>	getDeprecatedLicenseInfos()
List<LicenseException>	getLicenseExceptions()
List<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 Detail

LICENSE_XML_SCHEMA_LOCATION

public static final String LICENSE_XML_SCHEMA_LOCATION

See Also:

Constant Field Values

Constructor Detail

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 Detail

getListedLicenses

public List<SpdxListedLicense> getListedLicenses()
                                          throws InvalidSPDXAnalysisException,
                                                 LicenseXmlException

Will skip deprecated licenses

Returns:

Throws:

InvalidSPDXAnalysisException

LicenseXmlException

getLicenseExceptions

public List<LicenseException> getLicenseExceptions()
                                            throws LicenseXmlException

Returns:

Throws:

LicenseXmlException

getDeprecatedLicenseInfos

public List<SPDXLicenseSpreadsheet.DeprecatedLicenseInfo> getDeprecatedLicenseInfos()
                                                                             throws InvalidSPDXAnalysisException,
                                                                                    LicenseXmlException

Returns:

Throws:

LicenseXmlException

InvalidSPDXAnalysisException