Package adams.doc.listing

Class ConsoleOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.AbstractListingOutput

adams.doc.listing.ConsoleOutput

All Implemented Interfaces:

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

public class ConsoleOutput
extends AbstractListingOutput

Outputs the listings in simple plain text in the console.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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
ConsoleOutput()

Method Summary

Modifier and Type	Method	Description
protected String	doGenerate(Class superclass, Map<String,List<String>> listing)	Outputs the supplied listing.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.doc.listing.AbstractListingOutput

check, generate, getModules, getQuickInfo

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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

ConsoleOutput

public ConsoleOutput()

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

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