Package adams.core.option.description

Class AdamsClassDescriptionGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.option.description.AbstractClassDescriptionGenerator

adams.core.option.description.AdamsClassDescriptionGenerator

All Implemented Interfaces:

LoggingSupporter, ClassDescriptionGenerator, SizeOfHandler, Serializable

public class AdamsClassDescriptionGenerator
extends AbstractClassDescriptionGenerator

Generates descriptions for ADAMS option handlers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.description.AbstractClassDescriptionGenerator

m_Cache, m_GeneratorClasses

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.core.option.description.ClassDescriptionGenerator

KEY_CLASS, KEY_OPTIONS

Constructor Summary

Constructors

Constructor	Description
AdamsClassDescriptionGenerator()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	generate(Object obj)	Generates the description for the object.
boolean	handles(Class cls)	Checks whether this class is handled by this generator.

Methods inherited from class adams.core.option.description.AbstractClassDescriptionGenerator

generate, getHandler, getHandler, handles, initHandlers, initialize

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, toString, wait, wait, wait

Constructor Detail

AdamsClassDescriptionGenerator

public AdamsClassDescriptionGenerator()

Method Detail

handles

public boolean handles(Class cls)

Checks whether this class is handled by this generator.

Parameters:

cls - the class to check

Returns:

true if handled

generate

public Map<String,Object> generate(Object obj)

Generates the description for the object.

Parameters:

obj - the object to process

Returns:

the description, null if failed to generate