Package adams.core.option.help

Class CapabilitiesInfo

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.option.help.AbstractHelpGenerator

adams.core.option.help.CapabilitiesInfo

All Implemented Interfaces:

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

public class CapabilitiesInfo
extends AbstractHelpGenerator

Generates help for classes that implement the adams.ml.capabilities.CapabilitiesHandler interface.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

CapabilitiesHandler, Serialized Form

Field Summary

Fields inherited from class adams.core.option.help.AbstractHelpGenerator

LOGGER, m_ClassCrossRefLinks

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

Method Summary

Modifier and Type	Method	Description
String	generate(Object obj, HelpFormat format)	Generates the help for the object in the requested format.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Class cls)	Checks whether the generator handles this class.

Methods inherited from class adams.core.option.help.AbstractHelpGenerator

classCrossRefLinksTipText, defineOptions, generateAll, getClassCrossRefLinks, handles, setClassCrossRefLinks, toHTML, toHTML

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

CapabilitiesInfo

public CapabilitiesInfo()

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

handles

public boolean handles(Class cls)

Checks whether the generator handles this class.

Specified by:

handles in class AbstractHelpGenerator

Parameters:

cls - the class to check

Returns:

true if it can handle the class

generate

public String generate(Object obj,
                       HelpFormat format)

Generates the help for the object in the requested format.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

obj - the object to generate the help for

format - the format of the output

Returns:

the generated help