Libraries.System.Console Documentation
The Console is a helper class that represents printing and input windows. In addition to these helper methods, the console class also allows the user to retrieve any console arguments (also called command line arguments) that were passed to the program.
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
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. |
GetConsoleArguments() | This action retrieves a copy of the console arguments that were passed to the system. |
GetHashCode() | This action gets the hash code for an object. |
Input() | generates an input window and returns the text that was input. |
Input(text message) | This action generates an input window and returns the text that was input. |
Print(text value) | Prints a message to the sodbeans output window |
Actions Documentation
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
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetConsoleArguments()
This action retrieves a copy of the console arguments that were passed to the system.
Return
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.
Input()
generates an input window and returns the text that was input.
Example Code
text value = Input()
Return
text:
Input(text message)
This action generates an input window and returns the text that was input.
Example Code
text value = Input("What is your favorite color?")
Parameters
- text message: The message to display in the input box.
Return
text:
Print(text value)
Prints a message to the sodbeans output window
Example Code
Print "some message"
Parameters
- text value: The text to output to the output console.