org.easybatch.extensions.yaml

Class YamlFileRecordReader

java.lang.Object

org.easybatch.core.reader.AbstractFileRecordReader

org.easybatch.extensions.yaml.YamlFileRecordReader

All Implemented Interfaces:

RecordReader

public class YamlFileRecordReader
extends AbstractFileRecordReader

RecordReader that reads yaml records delimited by "---" from a given file. This reader produces YamlRecord instances.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Field Summary

Fields inherited from class org.easybatch.core.reader.AbstractFileRecordReader

charset, file

Constructor Summary

Constructors

Constructor and Description
YamlFileRecordReader(java.io.File yamlFile) Deprecated. This constructor is deprecated since v5.3 and will be removed in v6. Use YamlFileRecordReader(java.nio.file.Path) instead
YamlFileRecordReader(java.io.File yamlFile, java.lang.String charset) Deprecated. This constructor is deprecated since v5.3 and will be removed in v6. Use YamlFileRecordReader(java.nio.file.Path, java.nio.charset.Charset) instead
YamlFileRecordReader(java.nio.file.Path yamlFile) Create a new YamlFileRecordReader.
YamlFileRecordReader(java.nio.file.Path yamlFile, java.nio.charset.Charset charset) Create a new YamlFileRecordReader.

Method Summary

Modifier and Type	Method and Description
void	close()
void	open()
YamlRecord	readRecord()

Methods inherited from class org.easybatch.core.reader.AbstractFileRecordReader

getCharset, getFile

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileRecordReader

@Deprecated
public YamlFileRecordReader(java.io.File yamlFile)

Deprecated. This constructor is deprecated since v5.3 and will be removed in v6. Use YamlFileRecordReader(java.nio.file.Path) instead

Create a new YamlFileRecordReader.

Parameters:

yamlFile - to read records from

YamlFileRecordReader

@Deprecated
public YamlFileRecordReader(java.io.File yamlFile,
                                        java.lang.String charset)

Deprecated. This constructor is deprecated since v5.3 and will be removed in v6. Use YamlFileRecordReader(java.nio.file.Path, java.nio.charset.Charset) instead

Create a new YamlFileRecordReader.

Parameters:

yamlFile - to read records from

charset - of the input file

YamlFileRecordReader

public YamlFileRecordReader(java.nio.file.Path yamlFile)

Create a new YamlFileRecordReader.

Parameters:

yamlFile - to read records from

YamlFileRecordReader

public YamlFileRecordReader(java.nio.file.Path yamlFile,
                            java.nio.charset.Charset charset)

Create a new YamlFileRecordReader.

Parameters:

yamlFile - to read records from

charset - of the input file

Method Detail

open

public void open()
          throws java.lang.Exception

Throws:

java.lang.Exception

readRecord

public YamlRecord readRecord()
                      throws java.lang.Exception

Throws:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception