org.spdx.tools.licensegenerator

Class LicenseMarkdownFormatWriter

java.lang.Object

org.spdx.tools.licensegenerator.LicenseMarkdownFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class LicenseMarkdownFormatWriter
extends Object
implements ILicenseFormatWriter

Formats MarkDown files for the licenses

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
LicenseMarkdownFormatWriter(String version, String releaseDate, File markdownFile)

Method Summary

Modifier and Type	Method and Description
File	getMarkdownFile()
void	setMarkdownFile(File markdownFile)
void	writeException(LicenseException exception, boolean deprecated, String deprecatedVersion)
void	writeLicense(SpdxListedLicense license, boolean deprecated, String deprecatedVersion) Formats and writes a specific license
void	writeToC() Write the Table of Contents file for the format if applicable

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseMarkdownFormatWriter

public LicenseMarkdownFormatWriter(String version,
                                   String releaseDate,
                                   File markdownFile)

Parameters:

version - License list version

releaseDate - release date for the license list

markdownFile - Markdown formated file written by this class

Method Detail

getMarkdownFile

public File getMarkdownFile()

Returns:

the markdownFile

setMarkdownFile

public void setMarkdownFile(File markdownFile)

Parameters:

markdownFile - the markdownFile to set

writeLicense

public void writeLicense(SpdxListedLicense license,
                         boolean deprecated,
                         String deprecatedVersion)
                  throws IOException

Description copied from interface: ILicenseFormatWriter

Formats and writes a specific license

Specified by:

writeLicense in interface ILicenseFormatWriter

Parameters:

license - License to be added

deprecated - True if deprecated

deprecatedVersion - License list version when the license was deprecated, null otherwise

Throws:

IOException

writeToC

public void writeToC()
              throws IOException

Description copied from interface: ILicenseFormatWriter

Write the Table of Contents file for the format if applicable

Specified by:

writeToC in interface ILicenseFormatWriter

Throws:

IOException

writeException

public void writeException(LicenseException exception,
                           boolean deprecated,
                           String deprecatedVersion)
                    throws IOException

Specified by:

writeException in interface ILicenseFormatWriter

Parameters:

exception - Exception to be formatted and written

deprecated - True if deprecated

deprecatedVersion - License list version when the license was deprecated, null otherwise

Throws:

IOException