ImageWriter (adams-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, FileFormatHandler, OptionHandler

All Known Subinterfaces:

OutputStreamImageWriter<T>

All Known Implementing Classes:

AbstractImageWriter, ApacheCommonsImageWriter, BoofCVImageWriter, GrayOrIndexedImageWriter, JAIImageWriter, OpenCVImageWriter
```
public interface ImageWriter<T extends AbstractImageContainer>
extends OptionHandler, FileFormatHandler
```
Interface for image writers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ImageReader`	`getCorrespondingReader()`	Returns, if available, the corresponding reader.
`boolean`	`isAvailable()`	Returns whether the writer is actually available.
`String`	`write(PlaceholderFile file, T cont)`	Writes the image file.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.io.FileFormatHandler
getDefaultFormatExtension, getFormatDescription, getFormatExtensions

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - getCorrespondingReader
```
ImageReader getCorrespondingReader()
```
    Returns, if available, the corresponding reader.
    
    Returns:
    
    the reader, null if none available
  - isAvailable
```
boolean isAvailable()
```
    Returns whether the writer is actually available.
    
    Returns:
    
    true if available and ready to use
  - write
```
String write(PlaceholderFile file,
             T cont)
```
    Writes the image file.
    
    Parameters:
    
    file - the file to write to
    
    cont - the image container to write
    
    Returns:
    
    null if successfully written, otherwise error message