ReportWriter (adams-pom 24.12.0-SNAPSHOT API)

All Known Subinterfaces:

MultiReportWriter<T>, StringReportWriter<T>

All Known Implementing Classes:

AbstractMultiReportWriter, AbstractReportWriter, AbstractSimpleCSVReportWriter, AbstractSimpleJsonReportWriter, AbstractSimpleReportWriter, DeepLabCutCSVWriter, DefaultSimpleCSVReportWriter, DefaultSimpleJsonReportWriter, DefaultSimpleReportWriter, ObjectLocationsSpreadSheetWriter, OpexObjectLocationsWriter, ViaAnnotationsReportWriter, YoloAnnotationsReportWriter
```
public interface ReportWriter<T extends Report>
```
Interface for report writers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PlaceholderFile`	`getOutput()`	The file/directory to write to.
`String`	`outputTipText()`	Returns the tip text for this property.
`void`	`setOutput(PlaceholderFile value)`	Sets the file/directory to write to.
`boolean`	`write(T data)`	Performs checks and writes the data.

- Method Detail
  - setOutput
```
void setOutput(PlaceholderFile value)
```
    Sets the file/directory to write to.
    
    Parameters:
    
    value - the file/directory to write to
  - getOutput
```
PlaceholderFile getOutput()
```
    The file/directory to write to.
    
    Returns:
    
    the file/directory to write to
  - outputTipText
```
String outputTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - write
```
boolean write(T data)
```
    Performs checks and writes the data.
    
    Parameters:
    
    data - the data to write
    
    Returns:
    
    true if successfully written