org.safs.tools.input

Class InputRecordInfo

java.lang.Object

org.safs.tools.input.InputRecordInfo

All Implemented Interfaces:

InputRecordInterface

public class InputRecordInfo
extends java.lang.Object
implements InputRecordInterface

An instance of this object conveys the presence of valid data to any function expecting an InputRecordInterface return value. To convey an EOF or INVALID data scenario, it is easier to use the InputRecordInvalid class.

See Also:

InputRecordInvalid

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	recorddata
protected long	recordnum

Constructor Summary

Constructors

Constructor and Description
InputRecordInfo(java.lang.String recorddata, long recordnum) Constructor for InputRecordInfo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRecordData() Return the actual string data of the input record.
long	getRecordNumber() Return the row# or line# of the encapsulated data.
boolean	isValid() Returns TRUE if the values for recordnum and recorddata are valid.

Methods inherited from class java.lang.Object

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

Field Detail

recordnum

protected long recordnum

recorddata

protected java.lang.String recorddata

Constructor Detail

InputRecordInfo

public InputRecordInfo(java.lang.String recorddata,
                       long recordnum)

Constructor for InputRecordInfo

Method Detail

getRecordNumber

public long getRecordNumber()

Description copied from interface: InputRecordInterface

Return the row# or line# of the encapsulated data. Values less than 1 indicate no such record or EOF.

Specified by:

getRecordNumber in interface InputRecordInterface

See Also:

InputRecordInterface.getRecordNumber()

getRecordData

public java.lang.String getRecordData()

Description copied from interface: InputRecordInterface

Return the actual string data of the input record. A null value indicates no such record or EOF.

Specified by:

getRecordData in interface InputRecordInterface

See Also:

InputRecordInterface.getRecordData()

isValid

public boolean isValid()

Description copied from interface: InputRecordInterface

Returns TRUE if the values for recordnum and recorddata are valid.

Specified by:

isValid in interface InputRecordInterface

See Also:

InputRecordInterface.isValid()