build/javadoc/everything/antlr/TokenStreamCopyingHiddenTokenFilter.html - platform/external/arduino-ide - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--NewPage-->
 <HTML>
 <HEAD>
 <TITLE>
 TokenStreamCopyingHiddenTokenFilter
 </TITLE>

 <META NAME="keywords" CONTENT="antlr.TokenStreamCopyingHiddenTokenFilter class">

 <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">

 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     parent.document.title="TokenStreamCopyingHiddenTokenFilter";
 }
 </SCRIPT>
 <NOSCRIPT>
 </NOSCRIPT>

 </HEAD>

 <BODY BGCOLOR="white" onload="windowTitle();">


 <!-- ========= START OF TOP NAVBAR ======= -->
 <A NAME="navbar_top"><!-- --></A>
 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_top_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../antlr/ExtendedCommonASTWithHiddenTokens.html" title="class in antlr"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;NEXT CLASS</FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../index.html?antlr/TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
 <!-- ========= END OF TOP NAVBAR ========= -->

 <HR>
 <!-- ======== START OF CLASS DATA ======== -->
 <H2>
 <FONT SIZE="-1">
 antlr</FONT>
 <BR>
 Class TokenStreamCopyingHiddenTokenFilter</H2>
 <PRE>
 java.lang.Object
   <IMG SRC="../resources/inherit.gif" ALT="extended by ">antlr.TokenStreamBasicFilter
       <IMG SRC="../resources/inherit.gif" ALT="extended by ">antlr.TokenStreamHiddenTokenFilter
           <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>antlr.TokenStreamCopyingHiddenTokenFilter</B>
 </PRE>
 <DL>
 <DT><B>All Implemented Interfaces:</B> <DD>antlr.ASdebug.IASDebugStream, antlr.TokenStream</DD>
 </DL>
 <HR>
 <DL>
 <DT><PRE>public class <B>TokenStreamCopyingHiddenTokenFilter</B><DT>extends antlr.TokenStreamHiddenTokenFilter<DT>implements antlr.TokenStream</DL>
 </PRE>

 <P>
 This class provides TokenStreamHiddenTokenFilters with the concept of
  tokens which can be copied so that they are seen by both the hidden token
  stream as well as the parser itself.  This is useful when one wants to use
  an existing parser (like the Java parser included with ANTLR) that throws
  away some tokens to create a parse tree which can be used to spit out
  a copy of the code with only minor modifications.

  This code is partially derived from the public domain ANLTR TokenStream
 <P>

 <P>
 <HR>

 <P>

 <!-- ======== CONSTRUCTOR SUMMARY ======== -->

 <A NAME="constructor_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Constructor Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#TokenStreamCopyingHiddenTokenFilter(antlr.TokenStream)">TokenStreamCopyingHiddenTokenFilter</A></B>(antlr.TokenStream&nbsp;input)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 </TR>
 </TABLE>
 &nbsp;
 <!-- ========== METHOD SUMMARY =========== -->

 <A NAME="method_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Method Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#copy(int)">copy</A></B>(int&nbsp;tokenType)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate that all tokens of type tokenType should be copied.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#linkAndCopyToken(antlr.CommonHiddenStreamToken, antlr.CommonHiddenStreamToken)">linkAndCopyToken</A></B>(antlr.CommonHiddenStreamToken&nbsp;prev,
                  antlr.CommonHiddenStreamToken&nbsp;monitored)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;antlr.Token</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#nextToken()">nextToken</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the next monitored token.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;antlr.CommonHiddenStreamToken</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#partialCloneToken(antlr.CommonHiddenStreamToken)">partialCloneToken</A></B>(antlr.CommonHiddenStreamToken&nbsp;t)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a clone of the important parts of the given token.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_antlr.TokenStreamHiddenTokenFilter"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 <TH ALIGN="left"><B>Methods inherited from class antlr.TokenStreamHiddenTokenFilter</B></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE>getDiscardMask, getHiddenAfter, getHiddenBefore, getHideMask, getInitialHiddenToken, hide, hide</CODE></TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_antlr.TokenStreamBasicFilter"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 <TH ALIGN="left"><B>Methods inherited from class antlr.TokenStreamBasicFilter</B></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE>discard, discard, getEntireText, getOffsetInfo</CODE></TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 </TR>
 </TABLE>
 &nbsp;
 <P>

 <!-- ========= CONSTRUCTOR DETAIL ======== -->

 <A NAME="constructor_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Constructor Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="TokenStreamCopyingHiddenTokenFilter(antlr.TokenStream)"><!-- --></A><H3>
 TokenStreamCopyingHiddenTokenFilter</H3>
 <PRE>
 public <B>TokenStreamCopyingHiddenTokenFilter</B>(antlr.TokenStream&nbsp;input)</PRE>
 <DL>
 </DL>

 <!-- ============ METHOD DETAIL ========== -->

 <A NAME="method_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Method Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="copy(int)"><!-- --></A><H3>
 copy</H3>
 <PRE>
 public void <B>copy</B>(int&nbsp;tokenType)</PRE>
 <DL>
 <DD>Indicate that all tokens of type tokenType should be copied.  The copy
  is put in the stream of hidden tokens, and the original is returned in the
  stream of normal tokens.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>tokenType</CODE> - integer representing the token type to copied</DL>
 </DD>
 </DL>
 <HR>

 <A NAME="partialCloneToken(antlr.CommonHiddenStreamToken)"><!-- --></A><H3>
 partialCloneToken</H3>
 <PRE>
 public antlr.CommonHiddenStreamToken <B>partialCloneToken</B>(antlr.CommonHiddenStreamToken&nbsp;t)</PRE>
 <DL>
 <DD>Create a clone of the important parts of the given token.  Note that this
  does NOT copy the hiddenBefore and hiddenAfter fields.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>t</CODE> - token to partially clone
 <DT><B>Returns:</B><DD>newly created partial clone</DL>
 </DD>
 </DL>
 <HR>

 <A NAME="linkAndCopyToken(antlr.CommonHiddenStreamToken, antlr.CommonHiddenStreamToken)"><!-- --></A><H3>
 linkAndCopyToken</H3>
 <PRE>
 public void <B>linkAndCopyToken</B>(antlr.CommonHiddenStreamToken&nbsp;prev,
                              antlr.CommonHiddenStreamToken&nbsp;monitored)</PRE>
 <DL>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 </DD>
 </DL>
 <HR>

 <A NAME="nextToken()"><!-- --></A><H3>
 nextToken</H3>
 <PRE>
 public antlr.Token <B>nextToken</B>()
                       throws antlr.TokenStreamException</PRE>
 <DL>
 <DD>Return the next monitored token.
   Test the token following the monitored token.
   If following is another monitored token, save it
   for the next invocation of nextToken (like a single
   lookahead token) and return it then.
   If following is unmonitored, nondiscarded (hidden)
   channel token, add it to the monitored token.

   Note: EOF must be a monitored Token.
 <P>
 <DD><DL>
 <DT><B>Specified by:</B><DD><CODE>nextToken</CODE> in interface <CODE>antlr.TokenStream</CODE><DT><B>Overrides:</B><DD><CODE>nextToken</CODE> in class <CODE>antlr.TokenStreamHiddenTokenFilter</CODE></DL>
 </DD>
 <DD><DL>

 <DT><B>Throws:</B>
 <DD><CODE>antlr.TokenStreamException</CODE></DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>


 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <A NAME="navbar_bottom"><!-- --></A>
 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../antlr/ExtendedCommonASTWithHiddenTokens.html" title="class in antlr"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;NEXT CLASS</FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../index.html?antlr/TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_bottom"></A>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->

 <HR>

 </BODY>
 </HTML>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<TITLE>
	TokenStreamCopyingHiddenTokenFilter
	</TITLE>

	<META NAME="keywords" CONTENT="antlr.TokenStreamCopyingHiddenTokenFilter class">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	parent.document.title="TokenStreamCopyingHiddenTokenFilter";
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../antlr/ExtendedCommonASTWithHiddenTokens.html" title="class in antlr"><B>PREV CLASS</B></A>
	NEXT CLASS</FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../index.html?antlr/TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>FRAMES</B></A>
	<A HREF="TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	antlr</FONT>
	<BR>
	Class TokenStreamCopyingHiddenTokenFilter</H2>
	<PRE>
	java.lang.Object
	<IMG SRC="../resources/inherit.gif" ALT="extended by ">antlr.TokenStreamBasicFilter
	<IMG SRC="../resources/inherit.gif" ALT="extended by ">antlr.TokenStreamHiddenTokenFilter
	<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>antlr.TokenStreamCopyingHiddenTokenFilter</B>
	</PRE>
	<DL>
	<DT><B>All Implemented Interfaces:</B> <DD>antlr.ASdebug.IASDebugStream, antlr.TokenStream</DD>
	</DL>
	<HR>
	<DL>
	<DT><PRE>public class <B>TokenStreamCopyingHiddenTokenFilter</B><DT>extends antlr.TokenStreamHiddenTokenFilter<DT>implements antlr.TokenStream</DL>
	</PRE>

	<P>
	This class provides TokenStreamHiddenTokenFilters with the concept of
	tokens which can be copied so that they are seen by both the hidden token
	stream as well as the parser itself. This is useful when one wants to use
	an existing parser (like the Java parser included with ANTLR) that throws
	away some tokens to create a parse tree which can be used to spit out
	a copy of the code with only minor modifications.

	This code is partially derived from the public domain ANLTR TokenStream
	<P>

	<P>
	<HR>

	<P>

	<!-- ======== CONSTRUCTOR SUMMARY ======== -->

	<A NAME="constructor_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Constructor Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#TokenStreamCopyingHiddenTokenFilter(antlr.TokenStream)">TokenStreamCopyingHiddenTokenFilter</A></B>(antlr.TokenStream input)</CODE>

	<BR>
	</TD>
	</TR>
	</TABLE>

	<!-- ========== METHOD SUMMARY =========== -->

	<A NAME="method_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Method Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#copy(int)">copy</A></B>(int tokenType)</CODE>

	<BR>
	Indicate that all tokens of type tokenType should be copied.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#linkAndCopyToken(antlr.CommonHiddenStreamToken, antlr.CommonHiddenStreamToken)">linkAndCopyToken</A></B>(antlr.CommonHiddenStreamToken prev,
	antlr.CommonHiddenStreamToken monitored)</CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> antlr.Token</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#nextToken()">nextToken</A></B>()</CODE>

	<BR>
	Return the next monitored token.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> antlr.CommonHiddenStreamToken</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../antlr/TokenStreamCopyingHiddenTokenFilter.html#partialCloneToken(antlr.CommonHiddenStreamToken)">partialCloneToken</A></B>(antlr.CommonHiddenStreamToken t)</CODE>

	<BR>
	Create a clone of the important parts of the given token.</TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_antlr.TokenStreamHiddenTokenFilter"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class antlr.TokenStreamHiddenTokenFilter</B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE>getDiscardMask, getHiddenAfter, getHiddenBefore, getHideMask, getInitialHiddenToken, hide, hide</CODE></TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_antlr.TokenStreamBasicFilter"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class antlr.TokenStreamBasicFilter</B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE>discard, discard, getEntireText, getOffsetInfo</CODE></TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
	</TR>
	</TABLE>

	<P>

	<!-- ========= CONSTRUCTOR DETAIL ======== -->

	<A NAME="constructor_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Constructor Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="TokenStreamCopyingHiddenTokenFilter(antlr.TokenStream)"><!-- --></A><H3>
	TokenStreamCopyingHiddenTokenFilter</H3>
	<PRE>
	public <B>TokenStreamCopyingHiddenTokenFilter</B>(antlr.TokenStream input)</PRE>
	<DL>
	</DL>

	<!-- ============ METHOD DETAIL ========== -->

	<A NAME="method_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Method Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="copy(int)"><!-- --></A><H3>
	copy</H3>
	<PRE>
	public void <B>copy</B>(int tokenType)</PRE>
	<DL>
	<DD>Indicate that all tokens of type tokenType should be copied. The copy
	is put in the stream of hidden tokens, and the original is returned in the
	stream of normal tokens.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>tokenType</CODE> - integer representing the token type to copied</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="partialCloneToken(antlr.CommonHiddenStreamToken)"><!-- --></A><H3>
	partialCloneToken</H3>
	<PRE>
	public antlr.CommonHiddenStreamToken <B>partialCloneToken</B>(antlr.CommonHiddenStreamToken t)</PRE>
	<DL>
	<DD>Create a clone of the important parts of the given token. Note that this
	does NOT copy the hiddenBefore and hiddenAfter fields.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>t</CODE> - token to partially clone
	<DT><B>Returns:</B><DD>newly created partial clone</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="linkAndCopyToken(antlr.CommonHiddenStreamToken, antlr.CommonHiddenStreamToken)"><!-- --></A><H3>
	linkAndCopyToken</H3>
	<PRE>
	public void <B>linkAndCopyToken</B>(antlr.CommonHiddenStreamToken prev,
	antlr.CommonHiddenStreamToken monitored)</PRE>
	<DL>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="nextToken()"><!-- --></A><H3>
	nextToken</H3>
	<PRE>
	public antlr.Token <B>nextToken</B>()
	throws antlr.TokenStreamException</PRE>
	<DL>
	<DD>Return the next monitored token.
	Test the token following the monitored token.
	If following is another monitored token, save it
	for the next invocation of nextToken (like a single
	lookahead token) and return it then.
	If following is unmonitored, nondiscarded (hidden)
	channel token, add it to the monitored token.

	Note: EOF must be a monitored Token.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE>nextToken</CODE> in interface <CODE>antlr.TokenStream</CODE><DT><B>Overrides:</B><DD><CODE>nextToken</CODE> in class <CODE>antlr.TokenStreamHiddenTokenFilter</CODE></DL>
	</DD>
	<DD><DL>

	<DT><B>Throws:</B>
	<DD><CODE>antlr.TokenStreamException</CODE></DL>
	</DD>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../antlr/ExtendedCommonASTWithHiddenTokens.html" title="class in antlr"><B>PREV CLASS</B></A>
	NEXT CLASS</FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../index.html?antlr/TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>FRAMES</B></A>
	<A HREF="TokenStreamCopyingHiddenTokenFilter.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	</BODY>
	</HTML>