Libraries.System.Blueprints.FileRandomAccessBlueprint Documentation

Inheriting from FileRandomAccessBlueprint provides a standard interface for reading and writing files in a "random access" order. In this context, "random access" implies that the reading and writing does not have to occur in a sequential order. It is possible to, for example, write a character to the beginning of a file, and then jump to the end and read the last character, skipping all of the characters in-between. Random access is commonly used for manipulating binary data. See the FileRandomAccess 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 a CompareResult.
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.
GetPosition()
GoToBeginning()
IsAtEndOfFile()
OpenForRandomAccess(Libraries.System.File file)
Read(integer numberOfBytes)
Read()
ReadLine()
ReadLines()
SetPosition(number position)
Write(text textToWrite)
WriteLine(text textToWrite)

Actions Documentation

Close()

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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.

GetPosition()

Return

number

GoToBeginning()

IsAtEndOfFile()

Return

boolean

OpenForRandomAccess(Libraries.System.File file)

Parameters

Read(integer numberOfBytes)

Parameters

Return

text

Read()

Return

text

ReadLine()

Return

text

ReadLines()

Return

Libraries.Containers.Array

SetPosition(number position)

Parameters

Write(text textToWrite)

Parameters

WriteLine(text textToWrite)

Parameters