|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/antlr/antlr/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>ASTFactory (antlr Javadoc)</title><script src="../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="antlr.ASTFactory class"/><meta name="keywords" content="theASTNodeType"/><meta name="keywords" content="theASTNodeTypeClass"/><meta name="keywords" content="tokenTypeToASTClassMap"/><meta name="keywords" content="setTokenTypeASTNodeType()"/><meta name="keywords" content="getASTNodeType()"/><meta name="keywords" content="addASTChild()"/><meta name="keywords" content="create()"/><meta name="keywords" content="createUsingCtor()"/><meta name="keywords" content="dup()"/><meta name="keywords" content="dupList()"/><meta name="keywords" content="dupTree()"/><meta name="keywords" content="make()"/><meta name="keywords" content="makeASTRoot()"/><meta name="keywords" content="setASTNodeClass()"/><meta name="keywords" content="setASTNodeType()"/><meta name="keywords" content="getTokenTypeToASTClassMap()"/><meta name="keywords" content="setTokenTypeToASTClassMap()"/><meta name="keywords" content="error()"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="ASTFactory-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../antlr/ANTLRTokenTypes.html">Prev Class</a> | <a href="../antlr/ASTIterator.html">Next Class</a></td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="ASTFactory.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">antlr</h3><h1 class="class title-class">Class ASTFactory</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code><a href="file:/usr/share/javadoc/java/java/lang/Object.html">java.lang.Object</a></code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>antlr.ASTFactory</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">ASTFactory</b></code></div><div class="class synopsis superclass"><code>extends <a href="file:/usr/share/javadoc/java/java/lang/Object.html" title="Class in ">Object</a></code></div></div><hr/><div class="class description">AST Support code shared by TreeParser and Parser.
We use delegation to share code (and have only one
bit of code to maintain) rather than subclassing
or superclassing (forces AST support code to be
loaded even when you don't want to do AST stuff).
Typically, setASTNodeType is used to specify the
homogeneous type of node to create, but you can override
create to make heterogeneous nodes etc...
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#theASTNodeType">theASTNodeType</a></code></dt><dd class="description">Name of AST class to create during tree construction.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected Class</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#theASTNodeTypeClass">theASTNodeTypeClass</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected Hashtable</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#tokenTypeToASTClassMap">tokenTypeToASTClassMap</a></code></dt><dd class="description">How to specify the classname to create for a particular
token type.</dd></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#ASTFactory()">ASTFactory</a>()</code></dt></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#ASTFactory(Hashtable)">ASTFactory</a>(Hashtable tokenTypeToClassMap)</code></dt><dd class="description">Create factory with a specific mapping from token type
to Java AST node type.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#addASTChild(antlr.ASTPair,antlr.collections.AST)">addASTChild</a>(<a href="../antlr/ASTPair.html" title="Class in antlr">ASTPair</a> currentAST, <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> child)</code></dt><dd class="description">Add a child to the current AST </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create()">create</a>()</code></dt><dd class="description">Create a new empty AST node; if the user did not specify
an AST node type, then create a default one: CommonAST.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(Class)">create</a>(Class c)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(String)">create</a>(String className)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(antlr.Token)">create</a>(<a href="../antlr/Token.html" title="Class in antlr">Token</a> tok)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(antlr.Token,String)">create</a>(<a href="../antlr/Token.html" title="Class in antlr">Token</a> tok, String className)</code></dt><dd class="description">ANTLR generates reference to this when you reference a token
that has a specified heterogeneous AST node type.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(antlr.collections.AST)">create</a>(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> tr)</code></dt><dd class="description">Create a new empty AST node; if the user did not specify
an AST node type, then create a default one: CommonAST.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(int)">create</a>(int type)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(int,String)">create</a>(int type, String txt)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#create(int,String,String)">create</a>(int type, String txt, String className)</code></dt><dd class="description">Create an AST node with the token type and text passed in, but
with a specific Java object type.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#createUsingCtor(antlr.Token,String)">createUsingCtor</a>(<a href="../antlr/Token.html" title="Class in antlr">Token</a> token, String className)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#dup(antlr.collections.AST)">dup</a>(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</code></dt><dd class="description">Copy a single node with same Java AST objec type.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#dupList(antlr.collections.AST)">dupList</a>(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</code></dt><dd class="description">Duplicate tree including siblings of root.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#dupTree(antlr.collections.AST)">dupTree</a>(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</code></dt><dd class="description">Duplicate a tree, assuming this is a root node of a tree--
duplicate that node and what's below; ignore siblings of root node.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#error(String)">error</a>(String e)</code></dt><dd class="description">To change where error messages go, can subclass/override this method
and then setASTFactory in Parser and TreeParser.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Class</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getASTNodeType(int)">getASTNodeType</a>(int tokenType)</code></dt><dd class="description">For a given token type, what is the AST node object type to create
for it?
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Hashtable</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getTokenTypeToASTClassMap()">getTokenTypeToASTClassMap</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#make(antlr.collections.AST[])">make</a>(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a>[] nodes)</code></dt><dd class="description">Make a tree from a list of nodes.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#make(antlr.collections.impl.ASTArray)">make</a>(<a href="../antlr/collections/impl/ASTArray.html" title="Class in antlr.collections.impl">ASTArray</a> nodes)</code></dt><dd class="description">Make a tree from a list of nodes, where the nodes are contained
in an ASTArray object
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#makeASTRoot(antlr.ASTPair,antlr.collections.AST)">makeASTRoot</a>(<a href="../antlr/ASTPair.html" title="Class in antlr">ASTPair</a> currentAST, <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> root)</code></dt><dd class="description">Make an AST the root of current AST </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setASTNodeClass(String)">setASTNodeClass</a>(String t)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setASTNodeType(String)">setASTNodeType</a>(String t)</code></dt><dd class="description"><span class="deprecated"><b class="deprecated header">Deprecated. </b><i class="deprecated">since 2.7.1</i><span class="deprecated"></dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setTokenTypeASTNodeType(int,String)">setTokenTypeASTNodeType</a>(int tokenType, String className)</code></dt><dd class="description">Specify an "override" for the Java AST object created for a
specific token.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setTokenTypeToASTClassMap(Hashtable)">setTokenTypeToASTClassMap</a>(Hashtable tokenTypeToClassMap)</code></dt></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="theASTNodeType" id="theASTNodeType"/><div class="member detail outer"><h3 class="member detail name">theASTNodeType</h3><pre class="member detail synopsis">protected String theASTNodeType</pre><blockquote class="member detail name"><div class="member detail description">Name of AST class to create during tree construction.
Null implies that the create method should create
a default AST type such as CommonAST. This is for
homogeneous nodes.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="theASTNodeTypeClass" id="theASTNodeTypeClass"/><div class="member detail outer"><h3 class="member detail name">theASTNodeTypeClass</h3><pre class="member detail synopsis">protected Class theASTNodeTypeClass</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="tokenTypeToASTClassMap" id="tokenTypeToASTClassMap"/><div class="member detail outer"><h3 class="member detail name">tokenTypeToASTClassMap</h3><pre class="member detail synopsis">protected Hashtable tokenTypeToASTClassMap</pre><blockquote class="member detail name"><div class="member detail description">How to specify the classname to create for a particular
token type. Note that ANTLR allows you to say, for example,
tokens {
PLUS<ast=plusnode>;
...
}
and it tracks everything statically. #[PLUS] will make you
a PLUSNode w/o use of this table.
For tokens that ANTLR cannot track statically like #[i],
you can use this table to map PLUS (Integer) -> PLUSNode (Class)
etc... ANTLR sets the class map from the tokens {...} section
via the ASTFactory(Hashtable) ctor in antlr.Parser.
</ast=plusnode></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="ASTFactory()" id="ASTFactory()"/><div class="member detail outer"><h3 class="member detail name">ASTFactory</h3><pre class="member detail synopsis">public ASTFactory()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="ASTFactory(Hashtable)" id="ASTFactory(Hashtable)"/><div class="member detail outer"><h3 class="member detail name">ASTFactory</h3><pre class="member detail synopsis">public ASTFactory(Hashtable tokenTypeToClassMap)</pre><blockquote class="member detail name"><div class="member detail description">Create factory with a specific mapping from token type
to Java AST node type. Your subclasses of ASTFactory
can override and reuse the map stuff.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="addASTChild(antlr.ASTPair,antlr.collections.AST)" id="addASTChild(antlr.ASTPair,antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">addASTChild</h3><pre class="member detail synopsis">public void addASTChild(<a href="../antlr/ASTPair.html" title="Class in antlr">ASTPair</a> currentAST,
<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> child)</pre><blockquote class="member detail name"><div class="member detail description">Add a child to the current AST </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create()" id="create()"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create()</pre><blockquote class="member detail name"><div class="member detail description">Create a new empty AST node; if the user did not specify
an AST node type, then create a default one: CommonAST.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(Class)" id="create(Class)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">protected <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(Class c)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(String)" id="create(String)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(String className)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(antlr.Token)" id="create(antlr.Token)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(<a href="../antlr/Token.html" title="Class in antlr">Token</a> tok)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(antlr.Token,String)" id="create(antlr.Token,String)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(<a href="../antlr/Token.html" title="Class in antlr">Token</a> tok,
String className)</pre><blockquote class="member detail name"><div class="member detail description">ANTLR generates reference to this when you reference a token
that has a specified heterogeneous AST node type. This is
also a special case node creation routine for backward
compatibility. Before, ANTLR generated "new T(tokenObject)"
and so I must call the appropriate constructor not T().
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(antlr.collections.AST)" id="create(antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> tr)</pre><blockquote class="member detail name"><div class="member detail description">Create a new empty AST node; if the user did not specify
an AST node type, then create a default one: CommonAST.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(int)" id="create(int)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(int type)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(int,String)" id="create(int,String)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(int type,
String txt)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="create(int,String,String)" id="create(int,String,String)"/><div class="member detail outer"><h3 class="member detail name">create</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> create(int type,
String txt,
String className)</pre><blockquote class="member detail name"><div class="member detail description">Create an AST node with the token type and text passed in, but
with a specific Java object type. Typically called when you
say @[PLUS,"+",PLUSNode] in an antlr action.
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="createUsingCtor(antlr.Token,String)" id="createUsingCtor(antlr.Token,String)"/><div class="member detail outer"><h3 class="member detail name">createUsingCtor</h3><pre class="member detail synopsis">protected <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> createUsingCtor(<a href="../antlr/Token.html" title="Class in antlr">Token</a> token,
String className)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="dup(antlr.collections.AST)" id="dup(antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">dup</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> dup(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</pre><blockquote class="member detail name"><div class="member detail description">Copy a single node with same Java AST objec type.
Ignore the tokenType->Class mapping since you know
the type of the node, t.getClass(), and doing a dup.
clone() is not used because we want all AST creation
to go thru the factory so creation can be
tracked. Returns null if t is null.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="dupList(antlr.collections.AST)" id="dupList(antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">dupList</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> dupList(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</pre><blockquote class="member detail name"><div class="member detail description">Duplicate tree including siblings of root. </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="dupTree(antlr.collections.AST)" id="dupTree(antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">dupTree</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> dupTree(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> t)</pre><blockquote class="member detail name"><div class="member detail description">Duplicate a tree, assuming this is a root node of a tree--
duplicate that node and what's below; ignore siblings of root node.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="error(String)" id="error(String)"/><div class="member detail outer"><h3 class="member detail name">error</h3><pre class="member detail synopsis">public void error(String e)</pre><blockquote class="member detail name"><div class="member detail description">To change where error messages go, can subclass/override this method
and then setASTFactory in Parser and TreeParser. This method removes
a prior dependency on class antlr.Tool.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getASTNodeType(int)" id="getASTNodeType(int)"/><div class="member detail outer"><h3 class="member detail name">getASTNodeType</h3><pre class="member detail synopsis">public Class getASTNodeType(int tokenType)</pre><blockquote class="member detail name"><div class="member detail description">For a given token type, what is the AST node object type to create
for it?
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getTokenTypeToASTClassMap()" id="getTokenTypeToASTClassMap()"/><div class="member detail outer"><h3 class="member detail name">getTokenTypeToASTClassMap</h3><pre class="member detail synopsis">public Hashtable getTokenTypeToASTClassMap()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="make(antlr.collections.AST[])" id="make(antlr.collections.AST[])"/><div class="member detail outer"><h3 class="member detail name">make</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> make(<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a>[] nodes)</pre><blockquote class="member detail name"><div class="member detail description">Make a tree from a list of nodes. The first element in the
array is the root. If the root is null, then the tree is
a simple list not a tree. Handles null children nodes correctly.
For example, build(a, b, null, c) yields tree (a b c). build(null,a,b)
yields tree (nil a b).
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="make(antlr.collections.impl.ASTArray)" id="make(antlr.collections.impl.ASTArray)"/><div class="member detail outer"><h3 class="member detail name">make</h3><pre class="member detail synopsis">public <a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> make(<a href="../antlr/collections/impl/ASTArray.html" title="Class in antlr.collections.impl">ASTArray</a> nodes)</pre><blockquote class="member detail name"><div class="member detail description">Make a tree from a list of nodes, where the nodes are contained
in an ASTArray object
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="makeASTRoot(antlr.ASTPair,antlr.collections.AST)" id="makeASTRoot(antlr.ASTPair,antlr.collections.AST)"/><div class="member detail outer"><h3 class="member detail name">makeASTRoot</h3><pre class="member detail synopsis">public void makeASTRoot(<a href="../antlr/ASTPair.html" title="Class in antlr">ASTPair</a> currentAST,
<a href="../antlr/collections/AST.html" title="Interface in antlr.collections">AST</a> root)</pre><blockquote class="member detail name"><div class="member detail description">Make an AST the root of current AST </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setASTNodeClass(String)" id="setASTNodeClass(String)"/><div class="member detail outer"><h3 class="member detail name">setASTNodeClass</h3><pre class="member detail synopsis">public void setASTNodeClass(String t)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setASTNodeType(String)" id="setASTNodeType(String)"/><div class="member detail outer"><h3 class="member detail name">setASTNodeType</h3><pre class="member detail synopsis">public void setASTNodeType(String t)</pre><blockquote class="member detail name"><p class="deprecated"><b class="deprecated header">Deprecated. </b><i class="deprecated">since 2.7.1</i><p class="deprecated"><div class="member detail description">Specify the type of node to create during tree building.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setTokenTypeASTNodeType(int,String)" id="setTokenTypeASTNodeType(int,String)"/><div class="member detail outer"><h3 class="member detail name">setTokenTypeASTNodeType</h3><pre class="member detail synopsis">public void setTokenTypeASTNodeType(int tokenType,
String className)
throws IllegalArgumentException</pre><blockquote class="member detail name"><div class="member detail description">Specify an "override" for the Java AST object created for a
specific token. It is provided as a convenience so
you can specify node types dynamically. ANTLR sets
the token type mapping automatically from the tokens{...}
section, but you can change that mapping with this method.
ANTLR does it's best to statically determine the node
type for generating parsers, but it cannot deal with
dynamic values like #[LT(1)]. In this case, it relies
on the mapping. Beware differences in the tokens{...}
section and what you set via this method. Make sure
they are the same.
Set className to null to remove the mapping.
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>2.7.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setTokenTypeToASTClassMap(Hashtable)" id="setTokenTypeToASTClassMap(Hashtable)"/><div class="member detail outer"><h3 class="member detail name">setTokenTypeToASTClassMap</h3><pre class="member detail synopsis">public void setTokenTypeToASTClassMap(Hashtable tokenTypeToClassMap)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="ASTFactory-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr></table></body></html>