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

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.

Parameters

Return

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

Example

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

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetPosition()

Return

number

GoToBeginning()

IsAtEndOfFile()

Return

boolean

OpenForRandomAccess(Libraries.System.File file)

Parameters

Read(integer numberOfBytes)

Parameters

  • integer numberOfBytes

Return

text

Read()

Return

text

ReadLine()

Return

text

ReadLines()

Return

Libraries.Containers.Array

SetPosition(number position)

Parameters

  • number position

Write(text textToWrite)

Parameters

  • text textToWrite

WriteLine(text textToWrite)

Parameters

  • text textToWrite