SerializedParameterMapWriter (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.io.output.AbstractParameterMapWriter
      - adams.data.io.output.SerializedParameterMapWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable
```
public class SerializedParameterMapWriter
extends AbstractParameterMapWriter
```
Serializes a parameter map to a file.

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

SerializedParameterMapWriter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doWrite(Map<String,Object> params, PlaceholderFile output)`	Reads the parameters from the file.
`String`	`getDefaultFormatExtension()`	Returns the default extension of the format.
`String`	`getFormatDescription()`	Returns a string describing the format (used in the file chooser).
`String[]`	`getFormatExtensions()`	Returns the extension(s) of the format.
`String`	`globalInfo()`	Returns a string describing the object.

Methods inherited from class adams.data.io.output.AbstractParameterMapWriter
check, write

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, 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
  - SerializedParameterMapWriter
```
public SerializedParameterMapWriter()
```
- 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
  - getFormatDescription
```
public String getFormatDescription()
```
    Returns a string describing the format (used in the file chooser).
    
    Returns:
    
    a description suitable for displaying in the file chooser
  - getFormatExtensions
```
public String[] getFormatExtensions()
```
    Returns the extension(s) of the format.
    
    Returns:
    
    the extension (without the dot!)
  - getDefaultFormatExtension
```
public String getDefaultFormatExtension()
```
    Returns the default extension of the format.
    
    Returns:
    
    the default extension (without the dot!)
  - doWrite
```
protected void doWrite(Map<String,Object> params,
                       PlaceholderFile output)
                throws Exception
```
    Reads the parameters from the file.
    
    Specified by:
    
    doWrite in class AbstractParameterMapWriter
    
    Parameters:
    
    params - the parameters to write
    
    output - the output file to write to
    
    Throws:
    
    Exception - if reading fails