Libraries.System.Blueprints.FileReaderBlueprint Documentation

Inheriting from FileReaderBlueprint provides a standard interface for reading files in sequential order. See the FileReader class for the standard Quorum implementation of this blueprint.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Close()
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
IsAtEndOfFile()
OpenForRead(Libraries.System.File file)
Read(integer numberOfBytes)
Read()
ReadLine()
ReadLines()

Actions Documentation

Close()

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

IsAtEndOfFile()

Return

boolean

OpenForRead(Libraries.System.File file)

Parameters

Read(integer numberOfBytes)

Parameters

Return

text

Read()

Return

text

ReadLine()

Return

text

ReadLines()

Return

Libraries.Containers.Array