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	ALTERNATIVE_TAG
static String	BODY_TAG
static String	BREAK_TAG
static String	BULLET_TAG
static String	COPYRIGHT_TAG
static String	DEPRECATED_ATTRIBUTE
static String	HEADER_TAG
static String	ID_ATTRIBUTE
static String	LICENSE_TAG
static String	LIST_ITEM_TAG
static String	LIST_TAG
static String	NAME_ATTRIBUTE
static String	NOTES_TAG
static String	OPTIONAL_TAG
static String	OSI_APPROVED_ATTRIBUTE
static String	PARAGRAPH_TAG
static String	ROOT_ELEMENT_NAME
static String	TITLE_TAG
static String	URLS_TAG
static String	VAR_MATCH_ATTRIBUTE
static String	VAR_NAME_ATTRIBUTE
static String	VAR_ORIGINAL_ATTRIBUTE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SPDXLicenseSpreadsheet.DeprecatedLicenseInfo	getDeprecatedLicenseInfo()
LicenseException	getLicenseException()
SpdxListedLicense	getListedLicense()
boolean	isDeprecated()
boolean	isLicenseException()
boolean	isListedLicense()

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ELEMENT_NAME

public static final String ROOT_ELEMENT_NAME

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

See Also:

Constant Field Values

LICENSE_TAG

public static final String LICENSE_TAG

See Also:

Constant Field Values

BODY_TAG

public static final String BODY_TAG

See Also:

Constant Field Values

DEPRECATED_ATTRIBUTE

public static final String DEPRECATED_ATTRIBUTE

See Also:

Constant Field Values

NOTES_TAG

public static final String NOTES_TAG

See Also:

Constant Field Values

URLS_TAG

public static final String URLS_TAG

See Also:

Constant Field Values

HEADER_TAG

public static final String HEADER_TAG

See Also:

Constant Field Values

OSI_APPROVED_ATTRIBUTE

public static final String OSI_APPROVED_ATTRIBUTE

See Also:

Constant Field Values

COPYRIGHT_TAG

public static final String COPYRIGHT_TAG

See Also:

Constant Field Values

TITLE_TAG

public static final String TITLE_TAG

See Also:

Constant Field Values

LIST_ITEM_TAG

public static final String LIST_ITEM_TAG

See Also:

Constant Field Values

LIST_TAG

public static final String LIST_TAG

See Also:

Constant Field Values

ALTERNATIVE_TAG

public static final String ALTERNATIVE_TAG

See Also:

Constant Field Values

OPTIONAL_TAG

public static final String OPTIONAL_TAG

See Also:

Constant Field Values

BREAK_TAG

public static final String BREAK_TAG

See Also:

Constant Field Values

PARAGRAPH_TAG

public static final String PARAGRAPH_TAG

See Also:

Constant Field Values

VAR_NAME_ATTRIBUTE

public static final String VAR_NAME_ATTRIBUTE

See Also:

Constant Field Values

VAR_ORIGINAL_ATTRIBUTE

public static final String VAR_ORIGINAL_ATTRIBUTE

See Also:

Constant Field Values

VAR_MATCH_ATTRIBUTE

public static final String VAR_MATCH_ATTRIBUTE

See Also:

Constant Field Values

BULLET_TAG

public static final String BULLET_TAG

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

isListedLicense

public boolean isListedLicense()

Returns:

getListedLicense

public SpdxListedLicense getListedLicense()
                                   throws InvalidSPDXAnalysisException,
                                          LicenseXmlException

Returns:

Throws:

InvalidSPDXAnalysisException

LicenseXmlException

isLicenseException

public boolean isLicenseException()

Returns:

getLicenseException

public LicenseException getLicenseException()

Returns:

isDeprecated

public boolean isDeprecated()

Returns:

getDeprecatedLicenseInfo

public SPDXLicenseSpreadsheet.DeprecatedLicenseInfo getDeprecatedLicenseInfo()

Returns: