| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Token</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Token"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Step.html" title="class in org.apache.taglibs.standard.extra.spath"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/taglibs/standard/extra/spath/TokenMgrError.html" title="class in org.apache.taglibs.standard.extra.spath"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/taglibs/standard/extra/spath/Token.html" target="_top">Frames</a></li> |
| <li><a href="Token.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.taglibs.standard.extra.spath</div> |
| <h2 title="Class Token" class="title">Class Token</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.taglibs.standard.extra.spath.Token</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Token</span> |
| extends java.lang.Object</pre> |
| <div class="block">Describes the input token stream.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#beginColumn">beginColumn</a></span></code> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#beginLine">beginLine</a></span></code> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#endColumn">endColumn</a></span></code> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#endLine">endLine</a></span></code> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#image">image</a></span></code> |
| <div class="block">The string image of the token.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#kind">kind</a></span></code> |
| <div class="block">An integer that describes the kind of this token.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#next">next</a></span></code> |
| <div class="block">A reference to the next regular (non-special) token from the input |
| stream.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#specialToken">specialToken</a></span></code> |
| <div class="block">This field is used to access special tokens that occur prior to this |
| token, but after the immediately preceding regular (non-special) token.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#Token--">Token</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#newToken-int-">newToken</a></span>(int ofKind)</code> |
| <div class="block">Returns a new Token object, by default.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns the image.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="kind"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>kind</h4> |
| <pre>public int kind</pre> |
| <div class="block">An integer that describes the kind of this token. This numbering |
| system is determined by JavaCCParser, and a table of these numbers is |
| stored in the file ...Constants.java.</div> |
| </li> |
| </ul> |
| <a name="beginLine"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginLine</h4> |
| <pre>public int beginLine</pre> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </li> |
| </ul> |
| <a name="beginColumn"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginColumn</h4> |
| <pre>public int beginColumn</pre> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </li> |
| </ul> |
| <a name="endLine"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endLine</h4> |
| <pre>public int endLine</pre> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </li> |
| </ul> |
| <a name="endColumn"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endColumn</h4> |
| <pre>public int endColumn</pre> |
| <div class="block">beginLine and beginColumn describe the position of the first character |
| of this token; endLine and endColumn describe the position of the |
| last character of this token.</div> |
| </li> |
| </ul> |
| <a name="image"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>image</h4> |
| <pre>public java.lang.String image</pre> |
| <div class="block">The string image of the token.</div> |
| </li> |
| </ul> |
| <a name="next"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>public <a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a> next</pre> |
| <div class="block">A reference to the next regular (non-special) token from the input |
| stream. If this is the last token from the input stream, or if the |
| token manager has not read tokens beyond this one, this field is |
| set to null. This is true only if this token is also a regular |
| token. Otherwise, see below for a description of the contents of |
| this field.</div> |
| </li> |
| </ul> |
| <a name="specialToken"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>specialToken</h4> |
| <pre>public <a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a> specialToken</pre> |
| <div class="block">This field is used to access special tokens that occur prior to this |
| token, but after the immediately preceding regular (non-special) token. |
| If there are no such special tokens, this field is set to null. |
| When there are more than one such special token, this field refers |
| to the last of these special tokens, which in turn refers to the next |
| previous special token through its specialToken field, and so on |
| until the first special token (whose specialToken field is null). |
| The next fields of special tokens refer to other special tokens that |
| immediately follow it (without an intervening regular token). If there |
| is no such token, this field is null.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Token--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Token</h4> |
| <pre>public Token()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public final java.lang.String toString()</pre> |
| <div class="block">Returns the image.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newToken-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newToken</h4> |
| <pre>public static final <a href="../../../../../../org/apache/taglibs/standard/extra/spath/Token.html" title="class in org.apache.taglibs.standard.extra.spath">Token</a> newToken(int ofKind)</pre> |
| <div class="block">Returns a new Token object, by default. However, if you want, you |
| can create and return subclass objects based on the value of ofKind. |
| Simply add the cases to the switch for all those special cases. |
| For example, if you have a subclass of Token called IDToken that |
| you want to create if ofKind is ID, simlpy add something like : |
| |
| case MyParserConstants.ID : return new IDToken(); |
| |
| to the following switch statement. Then you can cast matchedToken |
| variable to the appropriate type and use it in your lexical actions.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/taglibs/standard/extra/spath/Step.html" title="class in org.apache.taglibs.standard.extra.spath"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/taglibs/standard/extra/spath/TokenMgrError.html" title="class in org.apache.taglibs.standard.extra.spath"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/taglibs/standard/extra/spath/Token.html" target="_top">Frames</a></li> |
| <li><a href="Token.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
