CsvDestination (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.reporting.destination.AbstractDestination
- - org.perfcake.reporting.destination.CsvDestination

All Implemented Interfaces:

Closeable, AutoCloseable, Destination
```
public class CsvDestination
extends AbstractDestination
```
Appends a Measurement into a CSV file.

Author:

Pavel Macík, Martin Večeřa

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CsvDestination.AppendStrategy` Determines the strategy for a case that the output file exists.
`static class`	`CsvDestination.MissingStrategy` Determines the strategy for a case that the value of an expected attribute in report to be published is missing.

Constructor Summary

Constructors
Constructor and Description

CsvDestination()

Constructors
Constructor and Description
`CsvDestination()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the destination.
`CsvDestination.AppendStrategy`	`getAppendStrategy()` Gets the current append strategy used to write results to the CSV file.
`String`	`getDelimiter()` Gets the line data elements delimiter.
`String`	`getExpectedAttributes()` Gets the exppected attributes that will be written to the CSV file.
`List<String>`	`getExpectedAttributesAsList()` Gets the exppected attributes that will be written to the CSV file as a List.
`String`	`getLineBreak()` Gets the delimiter used to separate individual lines in the output files.
`String`	`getLinePrefix()` Gets the data line prefix.
`String`	`getLineSuffix()` Gets the data line suffix.
`CsvDestination.MissingStrategy`	`getMissingStrategy()` Gets the current missing strategy used to write results to the CSV file.
`String`	`getPath()` Gets the currently used output file path.
`boolean`	`isSkipHeader()` When true, headers are not written to the output file.
`void`	`open()` Opens the destination for reporting.
`void`	`report(Measurement measurement)` Reports a new `Measurement` to the destination.
`CsvDestination`	`setAppendStrategy(CsvDestination.AppendStrategy appendStrategy)` Sets the append strategy to be used when writing to the CSV file.
`CsvDestination`	`setDelimiter(String delimiter)` Sets the delimiter used in a line between individual data elements.
`CsvDestination`	`setExpectedAttributes(String expectedAttributes)` Sets the exppected attributes that will be written to the CSV file.
`CsvDestination`	`setLineBreak(String lineBreak)` Sets the delimiter used to separate individual lines in the output files.
`CsvDestination`	`setLinePrefix(String linePrefix)` Sets the data line prefix.
`CsvDestination`	`setLineSuffix(String lineSuffix)` Sets the data line suffix.
`CsvDestination`	`setMissingStrategy(CsvDestination.MissingStrategy missingStrategy)` Sets the missing strategy to be used when writing to the CSV file.
`CsvDestination`	`setPath(String path)` Sets the output file path.
`CsvDestination`	`setSkipHeader(boolean skipHeader)` Specifies whether headers should be ommited from the output file.

Methods inherited from class org.perfcake.reporting.destination.AbstractDestination
getParentReporter, open

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CsvDestination
```
public CsvDestination()
```
- Method Detail
  - open
```
public void open()
```
    Description copied from class: AbstractDestination
    
    Opens the destination for reporting.
    
    Specified by:
    
    open in class AbstractDestination
  - close
```
public void close()
```
    Description copied from interface: Destination
    
    Closes the destination. No other value should be reported after that.
  - report
```
public void report(Measurement measurement)
            throws ReportingException
```
    Description copied from interface: Destination
    
    Reports a new Measurement to the destination.
    
    Parameters:
    
    measurement - A measurement to be reported.
    
    Throws:
    
    ReportingException - When an error occurred during reporting the measurement like no space left on device. The root cause should be encapsulated.
  - getPath
```
public String getPath()
```
    Gets the currently used output file path.
    
    Returns:
    
    The current output file path.
  - setPath
```
public CsvDestination setPath(String path)
```
    Sets the output file path. Once the destination opens the target file, the changes to this property are ignored.
    
    Parameters:
    
    path - The output file path to be set.
    
    Returns:
    
    Instance of this to support fluent API.
  - getDelimiter
```
public String getDelimiter()
```
    Gets the line data elements delimiter.
    
    Returns:
    
    The data elements delimiter.
  - setDelimiter
```
public CsvDestination setDelimiter(String delimiter)
```
    Sets the delimiter used in a line between individual data elements.
    
    Parameters:
    
    delimiter - The delimiter to be used between data elements in an output line.
    
    Returns:
    
    Instance of this to support fluent API.
  - getAppendStrategy
```
public CsvDestination.AppendStrategy getAppendStrategy()
```
    Gets the current append strategy used to write results to the CSV file.
    
    Returns:
    
    The currently used append strategy
  - setAppendStrategy
```
public CsvDestination setAppendStrategy(CsvDestination.AppendStrategy appendStrategy)
```
    Sets the append strategy to be used when writing to the CSV file.
    
    Parameters:
    
    appendStrategy - The appendStrategy value to set.
    
    Returns:
    
    Instance of this to support fluent API.
  - getMissingStrategy
```
public CsvDestination.MissingStrategy getMissingStrategy()
```
    Gets the current missing strategy used to write results to the CSV file.
    
    Returns:
    
    The currently used missing strategy
  - setMissingStrategy
```
public CsvDestination setMissingStrategy(CsvDestination.MissingStrategy missingStrategy)
```
    Sets the missing strategy to be used when writing to the CSV file.
    
    Parameters:
    
    missingStrategy - The missingStrategy value to set.
    
    Returns:
    
    Instance of this to support fluent API.
  - getExpectedAttributes
```
public String getExpectedAttributes()
```
    Gets the exppected attributes that will be written to the CSV file.
    
    Returns:
    
    The exppected attributes separated by comma.
  - setExpectedAttributes
```
public CsvDestination setExpectedAttributes(String expectedAttributes)
```
    Sets the exppected attributes that will be written to the CSV file.
    
    Parameters:
    
    expectedAttributes - The exppected attributes separated by comma.
    
    Returns:
    
    Instance of this to support fluent API.
  - getExpectedAttributesAsList
```
public List<String> getExpectedAttributesAsList()
```
    Gets the exppected attributes that will be written to the CSV file as a List.
    
    Returns:
    
    The attributes list.
  - getLinePrefix
```
public String getLinePrefix()
```
    Gets the data line prefix.
    
    Returns:
    
    The data line prefix.
  - setLinePrefix
```
public CsvDestination setLinePrefix(String linePrefix)
```
    Sets the data line prefix. This string is written to the output file at the beginning of each line containing data (i.e. not to headers line).
    
    Parameters:
    
    linePrefix - The data lines prefix.
    
    Returns:
    
    Instance of this to support fluent API.
  - getLineSuffix
```
public String getLineSuffix()
```
    Gets the data line suffix.
    
    Returns:
    
    The data line suffix.
  - setLineSuffix
```
public CsvDestination setLineSuffix(String lineSuffix)
```
    Sets the data line suffix. This string is written to the output file at the end of each line containing data (i.e. not to headers line).
    
    Parameters:
    
    lineSuffix - The data lines suffix.
    
    Returns:
    
    Instance of this to support fluent API.
  - getLineBreak
```
public String getLineBreak()
```
    Gets the delimiter used to separate individual lines in the output files.
    
    Returns:
    
    The delimiter used to separate output lines.
  - setLineBreak
```
public CsvDestination setLineBreak(String lineBreak)
```
    Sets the delimiter used to separate individual lines in the output files.
    
    Parameters:
    
    lineBreak - The delimiter used to separate output lines.
    
    Returns:
    
    Instance of this to support fluent API.
  - isSkipHeader
```
public boolean isSkipHeader()
```
    When true, headers are not written to the output file.
    
    Returns:
    
    True when headers should be written to the output file, false otherwise.
  - setSkipHeader
```
public CsvDestination setSkipHeader(boolean skipHeader)
```
    Specifies whether headers should be ommited from the output file.
    
    Parameters:
    
    skipHeader - When set to true, headers are not written.
    
    Returns:
    
    Instance of this to support fluent API.

Class CsvDestination

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.perfcake.reporting.destination.AbstractDestination

Methods inherited from class java.lang.Object

Constructor Detail

CsvDestination

Method Detail

open

close

report

getPath

setPath

getDelimiter

setDelimiter

getAppendStrategy

setAppendStrategy

getMissingStrategy

setMissingStrategy

getExpectedAttributes

setExpectedAttributes

getExpectedAttributesAsList

getLinePrefix

setLinePrefix

getLineSuffix

setLineSuffix

getLineBreak

setLineBreak

isSkipHeader

setSkipHeader