AbstractMapToString (adams-pom 26.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.map.AbstractMapToString

All Implemented Interfaces:

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

Direct Known Subclasses:

MapToJson, MapToPlainText, MapToProperties, MapToYaml
```
public abstract class AbstractMapToString
extends AbstractOptionHandler
implements MapToString
```
Ancestor for conversion schemes that turn maps to strings.

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

AbstractMapToString()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(Map map)`	Checks the map before converting it.
`String`	`mapToString(Map map)`	Converts the map into a string.
`protected abstract String`	`toString(Map map)`	Converts the map into a string.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject
setLoggingLevel

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
  - AbstractMapToString
```
public AbstractMapToString()
```
- Method Detail
  - check
```
protected String check(Map map)
```
    Checks the map before converting it.
    
    Parameters:
    
    map - the map to check
    
    Returns:
    
    null if checks passed, otherwise error message
  - toString
```
protected abstract String toString(Map map)
```
    Converts the map into a string.
    
    Parameters:
    
    map - the map to convert
    
    Returns:
    
    the generated string
  - mapToString
```
public String mapToString(Map map)
```
    Converts the map into a string.
    
    Specified by:
    
    mapToString in interface MapToString
    
    Parameters:
    
    map - the map to convert
    
    Returns:
    
    the generated string