_parser_antlr_rule_wrapper_.antlrrulewrapper.md

antlr4-helper > "parser/antlr-rule-wrapper" > AntlrRuleWrapper

Interface: AntlrRuleWrapper

Hierarchy

AntlrRuleWrapper

Implemented by

• ImmutableAntlrRuleWrapper
• MutableAntlrRuleWrapper

Index

Methods

• createRuleError
• exists
• findRuleByName
• findRuleByPath
• findRulesByName
• findRulesByPath
• getChildren
• getName
• getParent
• getRange
• getRule
• getSiblings
• getText
• getToken
• getTokens
• hasToken
• inRange
• setText

---

Methods

createRuleError

▸ createRuleError(): AntlrRuleError

Returns: AntlrRuleError

---

exists

▸ exists(): boolean

Returns: boolean

---

findRuleByName

▸ findRuleByName(ruleName: string): AntlrRuleWrapper

Parameters:

Param	Type
ruleName	string

Returns: AntlrRuleWrapper

---

findRuleByPath

▸ findRuleByPath(xpath: string): AntlrRuleWrapper

Parameters:

Param	Type
xpath	string

Returns: AntlrRuleWrapper

---

findRulesByName

▸ findRulesByName(ruleName: string): AntlrRuleWrapper[]

Parameters:

Param	Type
ruleName	string

Returns: AntlrRuleWrapper[]

---

findRulesByPath

▸ findRulesByPath(xpath: string): AntlrRuleWrapper[]

Parameters:

Param	Type
xpath	string

Returns: AntlrRuleWrapper[]

---

getChildren

▸ getChildren(): AntlrRuleWrapper[]

Returns: AntlrRuleWrapper[]

---

getName

▸ getName(): string

Returns: string

---

getParent

▸ getParent(): AntlrRuleWrapper

Returns: AntlrRuleWrapper

---

getRange

▸ getRange(): AntlrRange

Returns: AntlrRange

---

getRule

▸ getRule(): ParserRuleContext

Returns: ParserRuleContext

---

getSiblings

▸ getSiblings(): AntlrRuleWrapper[]

Returns: AntlrRuleWrapper[]

---

getText

▸ getText(): string

Returns: string

---

getToken

▸ getToken(tokenRuleName?: string): AntlrTokenWrapper

Parameters:

Param	Type
Optional tokenRuleName	string

Returns: AntlrTokenWrapper

---

getTokens

▸ getTokens(tokenRuleName?: string): AntlrTokenWrapper[]

Parameters:

Param	Type
Optional tokenRuleName	string

Returns: AntlrTokenWrapper[]

---

hasToken

▸ hasToken(tokenRuleName: string): boolean

Parameters:

Param	Type
tokenRuleName	string

Returns: boolean

---

inRange

▸ inRange(point: object): boolean

Parameters:

Param	Type
point	object

Returns: boolean

---

setText

▸ setText(text: string): void

Parameters:

Param	Type
text	string

Returns: void

---