Package adams.doc.listing

Class MarkdownOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.AbstractListingOutput

adams.doc.listing.AbstractFileBasedListingOutput

adams.doc.listing.AbstractFileBasedListingOutputWithEncoding

adams.doc.listing.MarkdownOutput

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, EncodingSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class MarkdownOutput
extends AbstractFileBasedListingOutputWithEncoding

Outputs the listing in Markdown to the specified file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.doc.listing.AbstractFileBasedListingOutputWithEncoding

m_Encoding

Fields inherited from class adams.doc.listing.AbstractFileBasedListingOutput

m_OutputFile

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
MarkdownOutput()

Method Summary

Modifier and Type	Method	Description
protected String	doGenerate(Class superclass, Map<String,List<String>> listing)	Outputs the supplied listing.
protected PlaceholderFile	getDefaultOutputFile()	Returns the default output file.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.

Methods inherited from class adams.doc.listing.AbstractFileBasedListingOutputWithEncoding

defineOptions, encodingTipText, getEncoding, getQuickInfo, setEncoding

Methods inherited from class adams.doc.listing.AbstractFileBasedListingOutput

check, getOutputFile, setOutputFile

Methods inherited from class adams.doc.listing.AbstractListingOutput

generate, getModules

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

MarkdownOutput

public MarkdownOutput()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getDefaultOutputFile

protected PlaceholderFile getDefaultOutputFile()

Returns the default output file.

Specified by:

getDefaultOutputFile in class AbstractFileBasedListingOutput

Returns:

the default

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface FileWriter

Specified by:

outputFileTipText in class AbstractFileBasedListingOutput

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doGenerate

protected String doGenerate(Class superclass,
                            Map<String,List<String>> listing)

Outputs the supplied listing.

Specified by:

doGenerate in class AbstractListingOutput

Parameters:

superclass - the superclass this listing is for

listing - the listing to output (module -> classnames)

Returns:

null if successful, otherwise error message