Top Description Inners Fields Constructors Methods

org.antlr.v4.tool

public Class AttributeDict

Class Inheritance

extends Object

java.lang.Object
org.antlr.v4.tool.AttributeDict

Imports

org.antlr.v4.runtime.Token, org.antlr.v4.tool.ast.GrammarAST, java.util.Collections, .HashSet, .LinkedHashMap, .Set

Track the attributes within retval, arg lists etc...

Each rule has potentially 3 scopes: return values, parameters, and an implicitly-named scope (i.e., a scope defined in a rule). Implicitly-defined scopes are named after the rule; rules and scopes then must live in the same name space--no collisions allowed.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	AttributeDict.DictType

Field Summary

Modifier and Type	Field and Description
public GrammarAST	ast
public final LinkedHashMap<String, Attribute>	attributes The list of `Attribute` objects.
public String	name
public static final AttributeDict	predefinedTokenDict All `Token` scopes (token labels) share the same fixed scope of of predefined attributes.
public AttributeDict.DictType	type

Constructor Summary

Access	Constructor and Description
public	AttributeDict()
public	AttributeDict(AttributeDict.DictType type)

Method Summary

Modifier and Type	Method and Description
public Attribute	add(Attribute a)
public Attribute	get(String name)
public String	getName()
public Set<String>	intersection(AttributeDict other) Return the set of keys that collide from `this` and `other`.
public int	size()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ast	back to summary
public GrammarAST ast

attributes	back to summary
public final LinkedHashMap<String, Attribute> attributes The list of `Attribute` objects.

name	back to summary
public String name

predefinedTokenDict	back to summary
public static final AttributeDict predefinedTokenDict All `Token` scopes (token labels) share the same fixed scope of of predefined attributes. I keep this out of the `Token` interface to avoid a runtime type leakage.

type	back to summary
public AttributeDict.DictType type

Constructor Detail

AttributeDict	back to summary
public AttributeDict()

AttributeDict	back to summary
public AttributeDict(AttributeDict.DictType type)

Method Detail

add	back to summary
public Attribute add(Attribute a)

get	back to summary
public Attribute get(String name)

getName	back to summary
public String getName()

intersection	back to summary
public Set<String> intersection(AttributeDict other) Return the set of keys that collide from `this` and `other`.

size	back to summary
public int size()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

org.antlr.v4.tool back to summary

public final Enum AttributeDict.DictType

Class Inheritance

extends Enum<AttributeDict.DictType>

java.lang.Object
java.lang.Enum
org.antlr.v4.tool.AttributeDict.DictType

Field Summary

Modifier and Type	Field and Description
public static final AttributeDict.DictType	ARG
public static final AttributeDict.DictType	LOCAL
public static final AttributeDict.DictType	PREDEFINED_LEXER_RULE
public static final AttributeDict.DictType	PREDEFINED_RULE
public static final AttributeDict.DictType	RET
public static final AttributeDict.DictType	TOKEN

Constructor Summary

Access	Constructor and Description
private	DictType()

Method Summary

Modifier and Type	Method and Description
public static AttributeDict.DictType	valueOf(String name)
public static AttributeDict.DictType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ARG	back to summary
public static final AttributeDict.DictType ARG

LOCAL	back to summary
public static final AttributeDict.DictType LOCAL

PREDEFINED_LEXER_RULE	back to summary
public static final AttributeDict.DictType PREDEFINED_LEXER_RULE

PREDEFINED_RULE	back to summary
public static final AttributeDict.DictType PREDEFINED_RULE

RET	back to summary
public static final AttributeDict.DictType RET

TOKEN	back to summary
public static final AttributeDict.DictType TOKEN

Constructor Detail

DictType	back to summary
private DictType()

Method Detail

valueOf	back to summary
public static AttributeDict.DictType valueOf(String name)

values	back to summary
public static AttributeDict.DictType[] values()