MapToJson (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
      - adams.data.map.MapToJson

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, MapToString, Serializable
```
public class MapToJson
extends AbstractMapToString
```
Turns a JSON object into a string.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected boolean m_PrettyPrinting
whether to use pretty-printing.
- 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

MapToJson()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getPrettyPrinting()`	Returns whether pretty-printing is used or not.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`prettyPrintingTipText()`	Returns the tip text for this property.
`void`	`setPrettyPrinting(boolean value)`	Sets whether to use pretty-printing or not.
`protected String`	`toString(Map map)`	Converts the map into a string.

Methods inherited from class adams.data.map.AbstractMapToString
check, mapToString

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

- Field Detail
  - m_PrettyPrinting
```
protected boolean m_PrettyPrinting
```
    whether to use pretty-printing.
- Constructor Detail
  - MapToJson
```
public MapToJson()
```
- 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
  - setPrettyPrinting
```
public void setPrettyPrinting(boolean value)
```
    Sets whether to use pretty-printing or not.
    
    Parameters:
    
    value - true if to use pretty-printing
  - getPrettyPrinting
```
public boolean getPrettyPrinting()
```
    Returns whether pretty-printing is used or not.
    
    Returns:
    
    true if to use pretty-printing
  - prettyPrintingTipText
```
public String prettyPrintingTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - toString
```
protected String toString(Map map)
```
    Converts the map into a string.
    
    Specified by:
    
    toString in class AbstractMapToString
    
    Parameters:
    
    map - the map to convert
    
    Returns:
    
    the generated string