blob: ab1b035c444656a82ecdd9411f82e9fd07c0f3d7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:25 PDT 2012 -->
<TITLE>
MarkerInstruction
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xalan.xsltc.compiler.util.MarkerInstruction class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MarkerInstruction";
}
</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="class-use/MarkerInstruction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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="../../../../../../org/apache/xalan/xsltc/compiler/util/IntType.html" title="class in org.apache.xalan.xsltc.compiler.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MatchGenerator.html" title="class in org.apache.xalan.xsltc.compiler.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MarkerInstruction.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">
org.apache.xalan.xsltc.compiler.util</FONT>
<BR>
Class MarkerInstruction</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by ">Instruction
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xalan.xsltc.compiler.util.MarkerInstruction</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/OutlineableChunkEnd.html" title="class in org.apache.xalan.xsltc.compiler.util">OutlineableChunkEnd</A>, <A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/OutlineableChunkStart.html" title="class in org.apache.xalan.xsltc.compiler.util">OutlineableChunkStart</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>abstract class <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.39"><B>MarkerInstruction</B></A><DT>extends Instruction</DL>
</PRE>
<P>
A special abstract dummy subclass of
<CODE>org.apache.bcel.generic.Instruction</CODE> used to mark locations of
interest in an <CODE>org.apache.bcel.generic.InstructionList</CODE>. It and
its subclasses are only used as placeholders, and do not contribute to the
actual byte code instruction stream.
<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="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#MarkerInstruction()">MarkerInstruction</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Zero-argument constructor.</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="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#accept(Visitor)">accept</A></B>(Visitor&nbsp;v)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>org.apache.bcel.generic.Visitor</CODE>s will know nothing about this
kind of <CODE>org.apche.bcel.generic.Instruction</CODE>, so this method does
nothing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#consumeStack(ConstantPoolGen)">consumeStack</A></B>(ConstantPoolGen&nbsp;cpg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of JVM stack entries consumed by the instruction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Instruction</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#copy()">copy</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Produce a copy of the instruction.</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="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#dump(java.io.DataOutputStream)">dump</A></B>(java.io.DataOutputStream&nbsp;out)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dump instruction as byte code to stream out.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#produceStack(ConstantPoolGen)">produceStack</A></B>(ConstantPoolGen&nbsp;cpg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of JVM stack entries produced by the instruction.</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>clone, equals, finalize, 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="MarkerInstruction()"><!-- --></A><H3>
MarkerInstruction</H3>
<PRE>
public <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.45"><B>MarkerInstruction</B></A>()</PRE>
<DL>
<DD>Zero-argument constructor. Sets the opcode to an invalid value and
sets the length to zero, as it will not be written as part of the
generated byte code.
<P>
</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="accept(Visitor)"><!-- --></A><H3>
accept</H3>
<PRE>
public void <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.54"><B>accept</B></A>(Visitor&nbsp;v)</PRE>
<DL>
<DD><CODE>org.apache.bcel.generic.Visitor</CODE>s will know nothing about this
kind of <CODE>org.apche.bcel.generic.Instruction</CODE>, so this method does
nothing.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="consumeStack(ConstantPoolGen)"><!-- --></A><H3>
consumeStack</H3>
<PRE>
public final int <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.65"><B>consumeStack</B></A>(ConstantPoolGen&nbsp;cpg)</PRE>
<DL>
<DD>The number of JVM stack entries consumed by the instruction.
This instruction is just a place holder, so it does not consume any
stack entries.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cpg</CODE> - The <CODE>org.apache.bcel.generic.ConstantPoolGen</CODE> for the
current <CODE>org.apache.bcel.generic.ClassGen</CODE>
<DT><B>Returns:</B><DD><code>0</code> always</DL>
</DD>
</DL>
<HR>
<A NAME="produceStack(ConstantPoolGen)"><!-- --></A><H3>
produceStack</H3>
<PRE>
public final int <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.76"><B>produceStack</B></A>(ConstantPoolGen&nbsp;cpg)</PRE>
<DL>
<DD>The number of JVM stack entries produced by the instruction.
This instruction is just a place holder, so it does not produce any
stack entries.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cpg</CODE> - The <CODE>org.apache.bcel.generic.ConstantPoolGen</CODE> for the
current <CODE>org.apache.bcel.generic.ClassGen</CODE>
<DT><B>Returns:</B><DD><code>0</code> always</DL>
</DD>
</DL>
<HR>
<A NAME="copy()"><!-- --></A><H3>
copy</H3>
<PRE>
public Instruction <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.86"><B>copy</B></A>()</PRE>
<DL>
<DD>Produce a copy of the instruction. By default a
<A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html" title="class in org.apache.xalan.xsltc.compiler.util"><CODE>MarkerInstruction</CODE></A> has no parameters, so the base implementation
of <A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#copy()"><CODE>copy()</CODE></A> returns the instruction itself.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The instruction itself.</DL>
</DD>
</DL>
<HR>
<A NAME="dump(java.io.DataOutputStream)"><!-- --></A><H3>
dump</H3>
<PRE>
public final void <A HREF="../../../../../../src-html/org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html#line.95"><B>dump</B></A>(java.io.DataOutputStream&nbsp;out)
throws java.io.IOException</PRE>
<DL>
<DD>Dump instruction as byte code to stream out. A <A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html" title="class in org.apache.xalan.xsltc.compiler.util"><CODE>MarkerInstruction</CODE></A>
has no effect on the generated byte code so it is never emitted to the
output stream.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - Output stream
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</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="class-use/MarkerInstruction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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="../../../../../../org/apache/xalan/xsltc/compiler/util/IntType.html" title="class in org.apache.xalan.xsltc.compiler.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/xalan/xsltc/compiler/util/MatchGenerator.html" title="class in org.apache.xalan.xsltc.compiler.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/apache/xalan/xsltc/compiler/util/MarkerInstruction.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MarkerInstruction.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>