Libraries.Language.Compile.Symbol.Variable Documentation
Inherits from: Libraries.Language.Compile.Location, Libraries.Language.Object, Libraries.Language.Compile.Symbol.Symbol
Summary
Actions Summary Table
Actions Documentation
AddUsage(Libraries.Language.Compile.Location location)
Parameters
AddUseLocation(Libraries.Language.Compile.Location location)
Parameters
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.
CreateLocationCopy()
This action is a helper action to get copies of the location.
Return
Libraries.Language.Compile.Location:
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.
GetBytecodeLocation()
Return
integer
GetCodeCompletionItem(Libraries.Language.Compile.Symbol.Class calledFrom)
Parameters
Return
Libraries.Language.Compile.CodeCompletionItem
GetColumnNumber()
Return
integer
GetColumnNumberEnd()
Return
integer
GetDefaultGetterName()
This action determines what the default name for a getter would be for the variable.
Return
text:
GetDefaultSetterName()
This action determines what the default name for a setter would be for the variable.
Return
text:
GetDisplayName()
Return
text
GetDisplayNameWithGenerics()
Return
text
GetDisplayNameWithGenericsAsWeb()
Return
text
GetDocumentation()
Return
Libraries.Language.Compile.Symbol.Documentation
GetFile()
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.
GetIndex()
Return
integer
GetIndexEnd()
Return
integer
GetJavaScriptName()
Return
text
GetLineNumber()
Return
integer
GetLineNumberEnd()
Return
integer
GetName()
Return
text
GetParameterLocation()
Return
integer
GetParentClass()
This action returns the class this variable is contained in. It does not return the type of the variable.
Return
Libraries.Language.Compile.Symbol.Class:
GetStaticKey()
Return
text
GetType()
Return
Libraries.Language.Compile.Symbol.Type
GetTypeLocation()
Return
Libraries.Language.Compile.Location
GetUsageLocations()
Return
GetUseLocationIterator(Libraries.System.File file)
Parameters
Return
HasExplicitModifier()
Return
boolean
IsConstant()
Return
boolean
IsDefined()
particular variab
Return
boolean:
IsDefinedInAlwaysBlock()
This action determines what the default name for a setter would be for the variable.
Return
boolean:
IsField()
Return
boolean
IsFirstAssignment()
Return
boolean
IsParameter()
Return
boolean
IsPrivate()
Return
boolean
IsPublic()
Return
boolean
IsUsed()
Return
boolean
IsVisibleToDebugger()
This action sets the class this variable is contained in. It does not set the type of the variable.
Return
boolean:
RemoveUseLocations(Libraries.System.File file)
Parameters
SetBytecodeLocation(integer int)
Parameters
SetColumnNumber(integer column)
Parameters
SetColumnNumberEnd(integer column)
Parameters
SetConstant(boolean bool)
Parameters
SetDefinedInAlwaysBlock(boolean defined)
This action determines what the default name for a getter would be for the variable.
Parameters
SetDocumentation(Libraries.Language.Compile.Symbol.Documentation documentation)
Parameters
SetFile(Libraries.System.File file)
Parameters
SetFirstAssignment(boolean isFirstAssignment)
Parameters
SetHasExplicitModifier(boolean hasModifier)
Parameters
SetIndex(integer index)
Parameters
SetIndexEnd(integer index)
Parameters
SetIsDefined(boolean defined)
check if the class has a "use" for this pare
Parameters
SetIsField(boolean field)
Parameters
SetIsParameter(boolean isParameter)
Parameters
SetLineNumber(integer line)
Parameters
SetLineNumberEnd(integer line)
Parameters
SetLocation(Libraries.Language.Compile.Location location)
This action uses the location and resets the current error's data.
Parameters
SetName(text name)
Parameters
SetParameterLocation(integer int)
Parameters
SetParentClass(Libraries.Language.Compile.Symbol.Class c)
This action sets the class this variable is contained in. It does not set the type of the variable.
Parameters
SetPrivate()
SetPublic()
SetType(Libraries.Language.Compile.Symbol.Type type)
Parameters
SetTypeLocation(Libraries.Language.Compile.Location location)
Parameters
SetVisibleToDebugger(boolean visible)
This action returns the class this variable is contained in. It does not return the type of the variable.
Parameters
ToText()
This action is a helper action to get copies of the location.
Return
text: