Libraries.Language.Debug.Breakpoint Documentation

Inherits from: Libraries.Language.Object

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.

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)

GetCountFilter()

This returns the number of times the breakpoint should be hit. This is useful for creating one-off breakpoints, that fire only a single time, for example in a run forward to line call.

Return

integer:

GetDotName()

This method returns the dot version of a file name. For example, a class in the package foo, named bar, would return foo.bar. GetDotName

Return

text:

GetFile()

Return

Libraries.System.File

GetFullyQualifiedName()

This method returns a fully qualified class name. For example, a class in the package foo, named bar, would return foo/bar. GetFullyQualifiedName return

Return

text:

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()

GetLine()

This method returns the line number the breakpoint is on.

Return

integer:

GetStaticKey()

This method returns a key generated from information in the breakpoint that can be used to identify unique breakpoints. By default, implementors follow the format line:className.

Return

text:

HasCountFilter()

This method returns whether or not the breakpoint should be hit only a certain number of times.

Return

boolean:

SetDotName(text key)

This method returns the dot version of a file name. For example, a class in the package foo, named bar, would return foo.bar. GetDotName

Parameters

  • text key

SetFile(Libraries.System.File file)

Parameters

SetLine(integer line)

This method returns the line number the breakpoint is on.

Parameters

  • integer line