org.spdx.spdxspreadsheet

Class SPDXLicenseSpreadsheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSpreadsheet

org.spdx.spdxspreadsheet.SPDXLicenseSpreadsheet

All Implemented Interfaces:

ISpdxListedLicenseProvider

public class SPDXLicenseSpreadsheet
extends AbstractSpreadsheet
implements ISpdxListedLicenseProvider

A spreadhseet containing license information

Author:

Source Auditor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SPDXLicenseSpreadsheet.DeprecatedLicenseInfo
class	SPDXLicenseSpreadsheet.DeprecatedLicenseIterator
class	SPDXLicenseSpreadsheet.LicenseExceptionIterator
class	SPDXLicenseSpreadsheet.LicenseIterator

Field Summary

Fields inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

logger, saveFile, workbook

Constructor Summary

Constructors

Constructor and Description
SPDXLicenseSpreadsheet(File spreadsheetFile, boolean create, boolean readonly)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	create(File spreadsheetFile)
void	create(File spreadsheetFile, String version, String releaseDate)
Iterator<SPDXLicenseSpreadsheet.DeprecatedLicenseInfo>	getDeprecatedLicenseIterator()
DeprecatedLicenseSheet	getDeprecatedLicenseSheet()
Iterator<LicenseException>	getExceptionIterator()
LicenseExceptionSheet	getLicenseExceptionSheet()
Iterator<SpdxListedLicense>	getLicenseIterator()
LicenseSheet	getLicenseSheet()
List<String>	getWarnings()
String	verifyWorkbook()

Methods inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

close, writeToFile

Methods inherited from class java.lang.Object

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

Constructor Detail

SPDXLicenseSpreadsheet

public SPDXLicenseSpreadsheet(File spreadsheetFile,
                              boolean create,
                              boolean readonly)
                       throws SpreadsheetException

Throws:

SpreadsheetException

Method Detail

create

public void create(File spreadsheetFile)
            throws IOException,
                   SpreadsheetException

Specified by:

create in class AbstractSpreadsheet

Throws:

IOException

SpreadsheetException

create

public void create(File spreadsheetFile,
                   String version,
                   String releaseDate)
            throws IOException,
                   SpreadsheetException

Throws:

IOException

SpreadsheetException

clear

public void clear()

Specified by:

clear in class AbstractSpreadsheet

verifyWorkbook

public String verifyWorkbook()

Specified by:

verifyWorkbook in class AbstractSpreadsheet

getLicenseSheet

public LicenseSheet getLicenseSheet()

Returns:

the licenseSheet

getLicenseIterator

public Iterator<SpdxListedLicense> getLicenseIterator()

Specified by:

getLicenseIterator in interface ISpdxListedLicenseProvider

getDeprecatedLicenseIterator

public Iterator<SPDXLicenseSpreadsheet.DeprecatedLicenseInfo> getDeprecatedLicenseIterator()

Specified by:

getDeprecatedLicenseIterator in interface ISpdxListedLicenseProvider

getExceptionIterator

public Iterator<LicenseException> getExceptionIterator()
                                                throws LicenseRestrictionException,
                                                       SpreadsheetException

Specified by:

getExceptionIterator in interface ISpdxListedLicenseProvider

Throws:

LicenseRestrictionException

SpreadsheetException

getLicenseExceptionSheet

public LicenseExceptionSheet getLicenseExceptionSheet()

getDeprecatedLicenseSheet

public DeprecatedLicenseSheet getDeprecatedLicenseSheet()

getWarnings

public List<String> getWarnings()

Specified by:

getWarnings in interface ISpdxListedLicenseProvider