Package adams.doc.listing

Class AbstractListingOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.AbstractListingOutput

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFileBasedListingOutput, ConsoleOutput, OptionOutput

public abstract class AbstractListingOutput
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for classes that output the generated lists.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(Class superclass, Map<String,List<String>> listing)	Hook method for performing checks before generating the output.
protected abstract String	doGenerate(Class superclass, Map<String,List<String>> listing)	Outputs the supplied listing.
String	generate(Class superclass, Map<String,List<String>> listing)	Outputs the supplied listing.
protected List<String>	getModules(Map<String,List<String>> listing)	Returns the modules in a sorted list.
String	getQuickInfo()	Returns a quick info about the class, which will be displayed in the GUI.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

AbstractListingOutput

public AbstractListingOutput()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the class, which will be displayed in the GUI.
Default implementation just returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

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

Hook method for performing checks before generating the output.

Parameters:

superclass - the superclass this listing is for

listing - the listing data to check

Returns:

null if successful, otherwise error message

getModules

protected List<String> getModules(Map<String,List<String>> listing)

Returns the modules in a sorted list.

Parameters:

superclass - the superclass this listing is for

listing - the listing to get the modules from

Returns:

the sorted list

doGenerate

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

Outputs the supplied listing.

Parameters:

superclass - the superclass this listing is for

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

Returns:

null if successful, otherwise error message

generate

public String generate(Class superclass,
                       Map<String,List<String>> listing)

Outputs the supplied listing.

Parameters:

superclass - the superclass this listing is for

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

Returns:

null if successful, otherwise error message