de.siegmar.fastcsv.reader

Class NamedCsvReader

java.lang.Object

de.siegmar.fastcsv.reader.NamedCsvReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<NamedCsvRow>

public final class NamedCsvReader
extends java.lang.Object
implements java.lang.Iterable<NamedCsvRow>, java.io.Closeable

Header name based Csv reader implementation.

Example use:

 try (NamedCsvReader csvReader = NamedCsvReader.builder().build(path)) {
     for (NamedCsvRow row : csvReader) {
         ...
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NamedCsvReader.NamedCsvReaderBuilder This builder is used to create configured instances of NamedCsvReader.

Method Summary

Modifier and Type	Method and Description
static NamedCsvReader.NamedCsvReaderBuilder	builder() Constructs a NamedCsvReader.NamedCsvReaderBuilder to configure and build instances of this class.
void	close()
java.util.Set<java.lang.String>	getHeader() Returns the header columns.
CloseableIterator<NamedCsvRow>	iterator()
java.util.Spliterator<NamedCsvRow>	spliterator()
java.util.stream.Stream<NamedCsvRow>	stream() Creates a new sequential Stream from this instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

builder

public static NamedCsvReader.NamedCsvReaderBuilder builder()

Constructs a NamedCsvReader.NamedCsvReaderBuilder to configure and build instances of this class.

Returns:

a new NamedCsvReader.NamedCsvReaderBuilder instance.

getHeader

public java.util.Set<java.lang.String> getHeader()

Returns the header columns. Can be called at any time.

Returns:

the header columns

iterator

public CloseableIterator<NamedCsvRow> iterator()

Specified by:

iterator in interface java.lang.Iterable<NamedCsvRow>

spliterator

public java.util.Spliterator<NamedCsvRow> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<NamedCsvRow>

stream

public java.util.stream.Stream<NamedCsvRow> stream()

Creates a new sequential Stream from this instance.

A close handler is registered by this method in order to close the underlying resources. Don't forget to close the returned stream when you're done.

Returns:

a new sequential Stream.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object