Package adams.doc.listing

Class Listing

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.Listing

All Implemented Interfaces:

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

public class Listing
extends AbstractOptionHandler

Generates class listings per module.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Environment	the environment class (dummy option).
protected AbstractListingOutput	m_Output	the output scheme to use.
protected BaseClassname	m_Superclass	the superclass to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	environmentTipText()	Returns the tip text for this property.
String	generate()	Generates the listing.
String	getEnvironment()	returns the current classname of the environment class to use.
AbstractListingOutput	getOutput()	Returns the scheme for outputting the generated listing.
BaseClassname	getSuperclass()	Returns the superclass to use for the listing.
String	globalInfo()	Returns a string describing the object.
static void	main(String[] args)	For generating the listing from the commandline.
String	outputTipText()	Returns the tip text for this property.
static void	runListing(String[] options)	For generating the listing.
void	setEnvironment(String value)	sets the classname of the environment class to use.
void	setOutput(AbstractListingOutput value)	Sets the scheme for outputting the generated listing.
void	setSuperclass(BaseClassname value)	Sets the superclass to use for the listing.
String	superclassTipText()	Returns the tip text for this property.

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

Field Detail

m_Environment

protected String m_Environment

the environment class (dummy option).

m_Superclass

protected BaseClassname m_Superclass

the superclass to use.

m_Output

protected AbstractListingOutput m_Output

the output scheme to use.

Constructor Detail

Listing

public Listing()

Method Detail

globalInfo

public String globalInfo()

Description copied from class: AbstractOptionHandler

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEnvironment

public void setEnvironment(String value)

sets the classname of the environment class to use.

Parameters:

value - the environment class name

getEnvironment

public String getEnvironment()

returns the current classname of the environment class to use.

Returns:

the current classname of the environment class

environmentTipText

public String environmentTipText()

Returns the tip text for this property.

Returns:

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

setSuperclass

public void setSuperclass(BaseClassname value)

Sets the superclass to use for the listing.

Parameters:

value - the scheme

getSuperclass

public BaseClassname getSuperclass()

Returns the superclass to use for the listing.

Returns:

the scheme

superclassTipText

public String superclassTipText()

Returns the tip text for this property.

Returns:

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

setOutput

public void setOutput(AbstractListingOutput value)

Sets the scheme for outputting the generated listing.

Parameters:

value - the scheme

getOutput

public AbstractListingOutput getOutput()

Returns the scheme for outputting the generated listing.

Returns:

the scheme

outputTipText

public String outputTipText()

Returns the tip text for this property.

Returns:

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

generate

public String generate()

Generates the listing.

Returns:

null if successful, otherwise error message

runListing

public static void runListing(String[] options)
                       throws Exception

For generating the listing.

Parameters:

options - the commandline options

Throws:

Exception - if generation fails

main

public static void main(String[] args)
                 throws Exception

For generating the listing from the commandline.

Parameters:

args - the options

Throws:

Exception - if generation fails