AbstractIndexedSplitsRunsWriter (adams-pom 24.11.0-SNAPSHOT API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonIndexedSplitsRunsWriter, PropertiesIndexedSplitsRunsWriter
```
public abstract class AbstractIndexedSplitsRunsWriter
extends AbstractOptionHandler
implements FileFormatHandler
```
Ancestor for writers that writes files containing IndexedSplitsRuns.

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

AbstractIndexedSplitsRunsWriter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract boolean`	`doWrite(Writer writer, IndexedSplitsRuns runs, MessageCollection errors)`	Writes the split definitions to the specified reader.
`boolean`	`write(File file, IndexedSplitsRuns runs, MessageCollection errors)`	Writes the split definitions to the specified file.
`boolean`	`write(Writer writer, IndexedSplitsRuns runs, MessageCollection errors)`	Writes the split definitions to the specified reader.

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Constructor Detail
  - AbstractIndexedSplitsRunsWriter
```
public AbstractIndexedSplitsRunsWriter()
```
- Method Detail
  - doWrite
```
protected abstract boolean doWrite(Writer writer,
                                   IndexedSplitsRuns runs,
                                   MessageCollection errors)
```
    Writes the split definitions to the specified reader. The caller must close the writer object.
    
    Parameters:
    
    writer - the writer to write to
    
    runs - the runs to write
    
    errors - for storing errors
    
    Returns:
    
    whether successfully written
  - write
```
public boolean write(Writer writer,
                     IndexedSplitsRuns runs,
                     MessageCollection errors)
```
    Writes the split definitions to the specified reader. The caller must close the writer object.
    
    Parameters:
    
    writer - the writer to write to
    
    runs - the runs to write
    
    errors - for storing errors
    
    Returns:
    
    whether successfully written
  - write
```
public boolean write(File file,
                     IndexedSplitsRuns runs,
                     MessageCollection errors)
```
    Writes the split definitions to the specified file.
    
    Parameters:
    
    file - the file to write to
    
    runs - the runs to write
    
    errors - for storing errors
    
    Returns:
    
    whether successfully written