CsvSampleReader 5.6.3 API

All Implemented Interfaces:

java.io.Closeable , java.lang.AutoCloseable
```
public class CsvSampleReader
 implements Closeable
                    
```
Reader class for reading CSV files.
Handles SampleMetadata reading and sample extraction.

Since:

3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final SampleMetadata`	`metadata`

Constructor Summary

Constructors
Constructor	Description
`CsvSampleReader(File inputFile, char separator, boolean useSaveSampleCfg)`	Instantiates a new csv sample reader.
`CsvSampleReader(File inputFile, SampleMetadata metadata)`	Instantiates a new csv sample reader.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`SampleMetadata`	`getMetadata()`
`Sample`	`readSample()`
`Sample`	`peek()`
`boolean`	`hasNext()`
`void`	`close()`

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

- Constructor Detail
  - CsvSampleReader
```
CsvSampleReader(File inputFile, char separator, boolean useSaveSampleCfg)
```
    Instantiates a new csv sample reader.
    
    Parameters:
    
    inputFile - the input file (must not be null)
    
    separator - the separator
    
    useSaveSampleCfg - indicates whether the reader uses jmeter SampleSaveConfiguration to define metadata
  - CsvSampleReader
```
CsvSampleReader(File inputFile, SampleMetadata metadata)
```
    Instantiates a new csv sample reader.
    
    Parameters:
    
    inputFile - the input file (must not be null)
    
    metadata - the metadata
- Method Detail
  - getMetadata
```
 SampleMetadata getMetadata()
```
  - readSample
```
 Sample readSample()
```
    Returns:
    
    next sample from the file.
  - peek
```
 Sample peek()
```
    Returns:
    
    next sample from file but keep the reading file position.
  - hasNext
```
 boolean hasNext()
```
    Returns:
    
    flag, that indicates whether the file contains more samples
  - close
```
 void close()
```