java.lang.Object
- antlr.preprocessor.Grammar

```
class Grammar
extends Object
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`alreadyExpanded`
`protected Tool`	`antlrTool`
`protected String`	`exportVocab`
`protected String`	`fileName`
`protected Hierarchy`	`hier`
`protected String`	`importVocab`
`protected String`	`memberAction`
`protected String`	`name`
`protected IndexedVector`	`options`
`protected String`	`preambleAction`
`protected boolean`	`predefined`
`protected IndexedVector`	`rules`
`protected boolean`	`specifiedVocabulary`
`protected String`	`superClass`	if not derived from another grammar, might still specify a non-ANTLR class to derive from like this "class T extends Parser(MyParserClass);"
`protected String`	`superGrammar`
`protected String`	`tokenSection`
`protected String`	`type`

Constructor Summary

Constructors
Constructor Description

Grammar(Tool tool, String name, String superGrammar, IndexedVector rules)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addOption(Option o)`
`void`	`addRule(Rule r)`
`void`	`expandInPlace()`	Copy all nonoverridden rules, vocabulary, and options into this grammar from supergrammar chain.
`String`	`getFileName()`
`String`	`getName()`
`IndexedVector`	`getOptions()`
`IndexedVector`	`getRules()`
`Grammar`	`getSuperGrammar()`
`String`	`getSuperGrammarName()`
`String`	`getType()`
`void`	`inherit(Option o, Grammar superG)`
`void`	`inherit(Rule r, Grammar superG)`
`void`	`inherit(String memberAction, Grammar superG)`
`boolean`	`isPredefined()`
`void`	`setFileName(String f)`
`void`	`setHierarchy(Hierarchy hier)`
`void`	`setMemberAction(String a)`
`void`	`setOptions(IndexedVector options)`
`void`	`setPreambleAction(String a)`
`void`	`setPredefined(boolean b)`
`void`	`setTokenSection(String tk)`
`void`	`setType(String t)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name
```
protected String name
```

fileName
```
protected String fileName
```

superGrammar
```
protected String superGrammar
```

type
```
protected String type
```

rules
```
protected IndexedVector rules
```

options
```
protected IndexedVector options
```

tokenSection
```
protected String tokenSection
```

preambleAction
```
protected String preambleAction
```

memberAction
```
protected String memberAction
```

hier
```
protected Hierarchy hier
```

predefined
```
protected boolean predefined
```

alreadyExpanded
```
protected boolean alreadyExpanded
```

specifiedVocabulary
```
protected boolean specifiedVocabulary
```

superClass
```
protected String superClass
```
if not derived from another grammar, might still specify a non-ANTLR class to derive from like this "class T extends Parser(MyParserClass);"

importVocab
```
protected String importVocab
```

exportVocab
```
protected String exportVocab
```

antlrTool
```
protected Tool antlrTool
```

Constructor Detail

Grammar

public Grammar(Tool tool,
               String name,
               String superGrammar,
               IndexedVector rules)

Method Detail

addOption
```
public void addOption(Option o)
```

addRule
```
public void addRule(Rule r)
```

expandInPlace
```
public void expandInPlace()
```
Copy all nonoverridden rules, vocabulary, and options into this grammar from supergrammar chain. The change is made in place; e.g., this grammar's vector of rules gets bigger. This has side-effects: all grammars on path to root of hierarchy are expanded also.

getFileName
```
public String getFileName()
```

getName
```
public String getName()
```

getOptions
```
public IndexedVector getOptions()
```

getRules
```
public IndexedVector getRules()
```

getSuperGrammar
```
public Grammar getSuperGrammar()
```

getSuperGrammarName
```
public String getSuperGrammarName()
```

getType
```
public String getType()
```

inherit

public void inherit(Option o,
                    Grammar superG)

inherit

public void inherit(Rule r,
                    Grammar superG)

inherit

public void inherit(String memberAction,
                    Grammar superG)

isPredefined
```
public boolean isPredefined()
```

setFileName
```
public void setFileName(String f)
```

setHierarchy

public void setHierarchy(Hierarchy hier)

setMemberAction

public void setMemberAction(String a)

setOptions

public void setOptions(IndexedVector options)

setPreambleAction

public void setPreambleAction(String a)

setPredefined

public void setPredefined(boolean b)

setTokenSection

public void setTokenSection(String tk)

setType
```
public void setType(String t)
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Grammar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

fileName

superGrammar

type

rules

options

tokenSection

preambleAction

memberAction

hier

predefined

alreadyExpanded

specifiedVocabulary

superClass

importVocab

exportVocab

antlrTool

Constructor Detail

Grammar

Method Detail

addOption

addRule

expandInPlace

getFileName

getName

getOptions

getRules

getSuperGrammar

getSuperGrammarName

getType

inherit

inherit

inherit

isPredefined

setFileName

setHierarchy

setMemberAction

setOptions

setPreambleAction

setPredefined

setTokenSection

setType

toString