Top Description Fields Constructors Methods
org.antlr.runtime

public Class ParserRuleReturnScope

extends RuleReturnScope
Class Inheritance

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. 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.

Field Summary

Modifier and TypeField and Description
public Token
public Token

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
getStart()

Overrides org.antlr.runtime.RuleReturnScope.getStart.

Return the start token or tree
public Object
getStop()

Overrides org.antlr.runtime.RuleReturnScope.getStop.

Return the stop token or tree
public Object
getTree()

Overrides org.antlr.runtime.RuleReturnScope.getTree.

Has a value potentially if output=AST;
Inherited from org.antlr.runtime.RuleReturnScope:
getTemplate

Field Detail

startback to summary
public Token start
stopback to summary
public Token stop

Constructor Detail

ParserRuleReturnScopeback to summary
public ParserRuleReturnScope()

Method Detail

getStartback to summary
public Object getStart()

Overrides org.antlr.runtime.RuleReturnScope.getStart.

Doc from org.antlr.runtime.RuleReturnScope.getStart.

Return the start token or tree

Annotations
@Override
getStopback to summary
public Object getStop()

Overrides org.antlr.runtime.RuleReturnScope.getStop.

Doc from org.antlr.runtime.RuleReturnScope.getStop.

Return the stop token or tree

Annotations
@Override
getTreeback to summary
public Object getTree()

Overrides org.antlr.runtime.RuleReturnScope.getTree.

Doc from org.antlr.runtime.RuleReturnScope.getTree.

Has a value potentially if output=AST;

Annotations
@Override