Click or drag to resize

ParserRuleReturnScopeTToken Class

Rules that return more than a single value must return an object containing all the values. Besides the properties defined in RuleLabelScope.predefinedRulePropertiesScope there may be user-defined return values. This class simply defines the minimum properties that are always defined and methods to access the others that might be available depending on output option such as template and tree.
Inheritance Hierarchy

Namespace:  Stimulsoft.Data.Expressions.Antlr.Runtime
Assembly:  Stimulsoft.Data (in Stimulsoft.Data.dll) Version: 2019.3.1.0
Syntax
public class ParserRuleReturnScope<TToken> : IRuleReturnScope<TToken>, 
	IRuleReturnScope

Type Parameters

TToken

[Missing <typeparam name="TToken"/> documentation for "T:Stimulsoft.Data.Expressions.Antlr.Runtime.ParserRuleReturnScope`1"]

The ParserRuleReturnScopeTToken type exposes the following members.

Constructors
  NameDescription
Public methodParserRuleReturnScopeTToken
Initializes a new instance of the ParserRuleReturnScopeTToken class
Top
Properties
  NameDescription
Public propertyStart
Public propertyStop
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
Note text is not an actual property of the return value, it is computed from start and stop using the input stream's toString() method. I could add a ctor to this so that we can pass in and store the input stream, but I'm not sure we want to do that. It would seem to be undefined to get the .text property anyway if the rule matches tokens from multiple input streams. I do not use getters for fields of objects that are used simply to group values such as this aggregate. The getters/setters are there to satisfy the superclass interface.
See Also