Module com.blackhillsoftware.zutil

Package com.blackhillsoftware.zutil.io

Class TextRecordReader

java.lang.Object

com.blackhillsoftware.zutil.io.RecordReader

com.blackhillsoftware.zutil.io.TextRecordReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class TextRecordReader
extends RecordReader
implements Closeable

Class to read records from z/OS datasets as Strings. Uses the com.ibm.jzos.RecordReader class to read the data and com.ibm.jzos.fields.StringField to convert the records to Strings.

Method Summary

Modifier and Type	Method	Description
String	getEncoding()	Get the encoding used to convert the data to a Java string
static TextRecordReader	newReader(String name, int flags)	Construct a new TextRecordReader using the same syntax as com.ibm.jzos.RecordReader.newReader(String name, int flags)
static TextRecordReader	newReaderForDD(String ddname)	Construct a new TextRecordReader using the same syntax as com.ibm.jzos.RecordReader.newReaderForDD(String ddname)
int	read(byte[] buf)	TextRecordReader does not support writing byte data
int	read(byte[] buf, int offset, int len)	TextRecordReader does not support writing byte data
List<String>	readAllLines()	Read all records from the current position to the end of the dataset
String	readLine()	Read the next record from the dataset
TextRecordReader	setEncoding(String encoding)	Set the EBCDIC variant encoding used to convert the data to a Java string

Methods inherited from class com.blackhillsoftware.zutil.io.RecordReader

close, getAutoFree, getBlksize, getDDName, getDsn, getLrecl, getRecfm, getRecfmBits, setAutoFree

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Method Details

newReader

public static TextRecordReader newReader(String name,
 int flags)
                                  throws IOException

Construct a new TextRecordReader using the same syntax as com.ibm.jzos.RecordReader.newReader(String name, int flags)

Throws:

IOException - if the JZOS native call fails

newReaderForDD

public static TextRecordReader newReaderForDD(String ddname)
                                       throws IOException

Construct a new TextRecordReader using the same syntax as com.ibm.jzos.RecordReader.newReaderForDD(String ddname)

Throws:

IOException - if the JZOS native call fails

setEncoding

public TextRecordReader setEncoding(String encoding)

Set the EBCDIC variant encoding used to convert the data to a Java string

Parameters:

encoding - the EBCDIC encoding e.g. "Cp1047"

Returns:

this TextRecordReader to allow fluent style usage

getEncoding

public String getEncoding()

Get the encoding used to convert the data to a Java string

Returns:

String the encoding value

readLine

public String readLine()
                throws IOException

Read the next record from the dataset

Returns:

String the record, converted to a Java String

Throws:

IOException

readAllLines

public List<String> readAllLines()
                          throws IOException

Read all records from the current position to the end of the dataset

Returns:

List<String> a list of records converted to Java Strings

Throws:

IOException

read

public int read(byte[] buf)

TextRecordReader does not support writing byte data

Overrides:

read in class RecordReader

read

public int read(byte[] buf,
 int offset,
 int len)

TextRecordReader does not support writing byte data

Overrides:

read in class RecordReader