Io Class

Article
04/11/2014

The Io class serves as the base class for the format-specific Io classes, which are used to access external files.

Syntax

class Io extends Object

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	finalize	Closes the file and, if data was written, flushes the file buffers to disk.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	inFieldDelimiter	Determines the delimiter used to separate fields in records accessed by the *Io classes.
	inRecordDelimiter	Determines to the *Io classes what character or characters to search for to determine whether a full record has been read.
	inRecordLength	Gets or sets the number of characters to read for each record in a file.
	new	Creates a new instance of the Io class. (Overrides the new Method.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	outFieldDelimiter	Gets or sets the sequence of characters that are written to a file that is used to separate the fields of a record.
	outRecordDelimiter	Gets or sets the sequence of characters that is written to the output files, which separate the records in the output files.
	owner	Returns the instance that owns the object. (Inherited from Object.)
	read	Reads the next full record from the Io object.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	status	Retrieves the status of the last operation performed on the Io object.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	write	Writes values of a simple type.
	writeExp	Writes the content of a container to the file.
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

The basic Io class features no actual data I/O but works as base class for the format-specific Io classes. The methods that are common to all Io classes are described here. For format-specific features and behavior of the member functions, refer to the documentation for each of the I/O classes.

To support reading and writing of different formats of external files, MorphX features a range of different Io classes: for comma-separated files, for comma-separated 7 bit files, for binary files, and for plain-text files.

Inheritance Hierarchy

Object Class
  Io Class
    BinaryIo Class
    CommaIo Class
    CommaTextIo Class

Share via