def.dom

Class TextStreamReader

java.lang.Object

def.js.Object

def.dom.TextStreamBase

def.dom.TextStreamReader

@Interface
public abstract class TextStreamReader
extends TextStreamBase

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	AtEndOfLine Indicates whether the stream pointer position is at the end of a line.
Boolean	AtEndOfStream Indicates whether the stream pointer position is at the end of a stream.

Fields inherited from class def.dom.TextStreamBase

Column, Line

Fields inherited from class def.js.Object

constructor, prototype

Constructor Summary

Constructors

Constructor and Description
TextStreamReader()

Method Summary

Modifier and Type	Method and Description
String	Read(double characters) Returns a specified number of characters from an input stream, starting at the current pointer position.
String	ReadAll() Returns all characters from an input stream.
String	ReadLine() Returns an entire line from an input stream.
void	Skip(double characters) Skips a specified number of characters when reading from an input text stream.
void	SkipLine() Skips the next line when reading from an input text stream.

Methods inherited from class def.dom.TextStreamBase

Close

Methods inherited from class def.js.Object

$applyStatic, $applyStatic, $delete, $delete, $get, $get, $set, $set, $super, assign, create, create, defineProperties, defineProperty, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, hasOwnProperty, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, propertyIsEnumerable, propertyIsEnumerable, seal, toJSString, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

AtEndOfLine

public Boolean AtEndOfLine

Indicates whether the stream pointer position is at the end of a line.

AtEndOfStream

public Boolean AtEndOfStream

Indicates whether the stream pointer position is at the end of a stream.

Constructor Detail

TextStreamReader

public TextStreamReader()

Method Detail

Read

public String Read(double characters)

Returns a specified number of characters from an input stream, starting at the current pointer position. Does not return until the ENTER key is pressed. Can only be used on a stream in reading mode; causes an error in writing or appending mode.

ReadAll

public String ReadAll()

Returns all characters from an input stream. Can only be used on a stream in reading mode; causes an error in writing or appending mode.

ReadLine

public String ReadLine()

Returns an entire line from an input stream. Although this method extracts the newline character, it does not add it to the returned string. Can only be used on a stream in reading mode; causes an error in writing or appending mode.

Skip

public void Skip(double characters)

Skips a specified number of characters when reading from an input text stream. Can only be used on a stream in reading mode; causes an error in writing or appending mode.

Parameters:

characters - Positive number of characters to skip forward. (Backward skipping is not supported.)

SkipLine

public void SkipLine()

Skips the next line when reading from an input text stream. Can only be used on a stream in reading mode, not writing or appending mode.