blob: d6377daf788371fe2844ebbdf5030c1cf782856a [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:39 PDT 2012 -->
<TITLE>
Arg
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xpath.Arg class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Arg";
}
</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/Arg.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../org/apache/xpath/CachedXPathAPI.html" title="class in org.apache.xpath"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/apache/xpath/Arg.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Arg.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.xpath</FONT>
<BR>
Class Arg</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.Arg</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.32"><B>Arg</B></A><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class holds an instance of an argument on
the stack. The value of the argument can be either an
XObject or a String containing an expression.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#m_expression">m_expression</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Field m_expression: Stored expression value of this argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#m_isFromWithParam">m_isFromWithParam</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if this variable was added with an xsl:with-param or
is added via setParameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#m_isVisible">m_isVisible</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if this variable is currently visible.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#m_qname">m_qname</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Field m_qname: The name of this argument, expressed as a QName
(Qualified Name) object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#m_val">m_val</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Field m_val: Stored XObject value of this argument</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/xpath/Arg.html#Arg()">Arg</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a dummy parameter argument, with no QName and no
value (either expression string or value XObject).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#Arg(org.apache.xml.utils.QName, java.lang.String, boolean)">Arg</A></B>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
java.lang.String&nbsp;expression,
boolean&nbsp;isFromWithParam)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a parameter argument that contains an expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#Arg(org.apache.xml.utils.QName, org.apache.xpath.objects.XObject)">Arg</A></B>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a parameter argument which has an XObject value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#Arg(org.apache.xml.utils.QName, org.apache.xpath.objects.XObject, boolean)">Arg</A></B>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val,
boolean&nbsp;isFromWithParam)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a parameter argument.</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/xpath/Arg.html#detach()">detach</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Have the object release it's resources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Equality function specialized for the variable name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#getExpression()">getExpression</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value expression for this argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#getQName()">getQName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the qualified name for this argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#getVal()">getVal</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value for this argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#isFromWithParam()">isFromWithParam</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if this variable is a parameter passed with a with-param or as
a top-level parameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/xpath/Arg.html#isVisible()">isVisible</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if this variable is currently visible.</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/xpath/Arg.html#setExpression(java.lang.String)">setExpression</A></B>(java.lang.String&nbsp;expr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value expression for this argument.</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/xpath/Arg.html#setIsVisible(boolean)">setIsVisible</A></B>(boolean&nbsp;b)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Update visibility status of this variable.</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/xpath/Arg.html#setQName(org.apache.xml.utils.QName)">setQName</A></B>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the qualified name for this argument.</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/xpath/Arg.html#setVal(org.apache.xpath.objects.XObject)">setVal</A></B>(<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of this argument.</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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="m_qname"><!-- --></A><H3>
m_qname</H3>
<PRE>
private <A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A> <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.40"><B>m_qname</B></A></PRE>
<DL>
<DD>Field m_qname: The name of this argument, expressed as a QName
(Qualified Name) object.
<P>
<DL>
<DT><B>See Also:</B><DD><CODE>getQName</CODE>,
<CODE>setQName</CODE></DL>
</DL>
<HR>
<A NAME="m_val"><!-- --></A><H3>
m_val</H3>
<PRE>
private <A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.66"><B>m_val</B></A></PRE>
<DL>
<DD>Field m_val: Stored XObject value of this argument
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#getVal()"><CODE>getVal()</CODE></A>,
<CODE>#setVal()</CODE></DL>
</DL>
<HR>
<A NAME="m_expression"><!-- --></A><H3>
m_expression</H3>
<PRE>
private java.lang.String <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.108"><B>m_expression</B></A></PRE>
<DL>
<DD>Field m_expression: Stored expression value of this argument.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#setExpression(java.lang.String)"><CODE>setExpression(java.lang.String)</CODE></A>,
<A HREF="../../../org/apache/xpath/Arg.html#getExpression()"><CODE>getExpression()</CODE></A></DL>
</DL>
<HR>
<A NAME="m_isFromWithParam"><!-- --></A><H3>
m_isFromWithParam</H3>
<PRE>
private boolean <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.138"><B>m_isFromWithParam</B></A></PRE>
<DL>
<DD>True if this variable was added with an xsl:with-param or
is added via setParameter.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_isVisible"><!-- --></A><H3>
m_isVisible</H3>
<PRE>
private boolean <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.156"><B>m_isVisible</B></A></PRE>
<DL>
<DD>True if this variable is currently visible. To be visible,
a variable needs to come either from xsl:variable or be
a "received" parameter, ie one for which an xsl:param has
been encountered.
Set at the time the object is constructed and updated as needed.
<P>
<DL>
</DL>
</DL>
<!-- ========= 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="Arg()"><!-- --></A><H3>
Arg</H3>
<PRE>
public <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.179"><B>Arg</B></A>()</PRE>
<DL>
<DD>Construct a dummy parameter argument, with no QName and no
value (either expression string or value XObject). isVisible
defaults to true.
<P>
</DL>
<HR>
<A NAME="Arg(org.apache.xml.utils.QName, java.lang.String, boolean)"><!-- --></A><H3>
Arg</H3>
<PRE>
public <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.197"><B>Arg</B></A>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
java.lang.String&nbsp;expression,
boolean&nbsp;isFromWithParam)</PRE>
<DL>
<DD>Construct a parameter argument that contains an expression.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>qname</CODE> - Name of the argument, expressed as a QName object.<DD><CODE>expression</CODE> - String to be stored as this argument's value expression.<DD><CODE>isFromWithParam</CODE> - True if this is a parameter variable.</DL>
</DL>
<HR>
<A NAME="Arg(org.apache.xml.utils.QName, org.apache.xpath.objects.XObject)"><!-- --></A><H3>
Arg</H3>
<PRE>
public <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.214"><B>Arg</B></A>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val)</PRE>
<DL>
<DD>Construct a parameter argument which has an XObject value.
isVisible defaults to true.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>qname</CODE> - Name of the argument, expressed as a QName object.<DD><CODE>val</CODE> - Value of the argument, expressed as an XObject</DL>
</DL>
<HR>
<A NAME="Arg(org.apache.xml.utils.QName, org.apache.xpath.objects.XObject, boolean)"><!-- --></A><H3>
Arg</H3>
<PRE>
public <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.249"><B>Arg</B></A>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;qname,
<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val,
boolean&nbsp;isFromWithParam)</PRE>
<DL>
<DD>Construct a parameter argument.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>qname</CODE> - Name of the argument, expressed as a QName object.<DD><CODE>val</CODE> - Value of the argument, expressed as an XObject<DD><CODE>isFromWithParam</CODE> - True if this is a parameter variable.</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="getQName()"><!-- --></A><H3>
getQName</H3>
<PRE>
public final <A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A> <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.47"><B>getQName</B></A>()</PRE>
<DL>
<DD>Get the qualified name for this argument.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>QName object containing the qualified name</DL>
</DD>
</DL>
<HR>
<A NAME="setQName(org.apache.xml.utils.QName)"><!-- --></A><H3>
setQName</H3>
<PRE>
public final void <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.57"><B>setQName</B></A>(<A HREF="../../../org/apache/xml/utils/QName.html" title="class in org.apache.xml.utils">QName</A>&nbsp;name)</PRE>
<DL>
<DD>Set the qualified name for this argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - QName object representing the new Qualified Name.</DL>
</DD>
</DL>
<HR>
<A NAME="getVal()"><!-- --></A><H3>
getVal</H3>
<PRE>
public final <A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.74"><B>getVal</B></A>()</PRE>
<DL>
<DD>Get the value for this argument.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the argument's stored XObject value.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#setVal(org.apache.xpath.objects.XObject)"><CODE>setVal(XObject)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setVal(org.apache.xpath.objects.XObject)"><!-- --></A><H3>
setVal</H3>
<PRE>
public final void <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.85"><B>setVal</B></A>(<A HREF="../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A>&nbsp;val)</PRE>
<DL>
<DD>Set the value of this argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>val</CODE> - an XObject representing the arguments's value.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#getVal()"><CODE>getVal()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="detach()"><!-- --></A><H3>
detach</H3>
<PRE>
public void <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.94"><B>detach</B></A>()</PRE>
<DL>
<DD>Have the object release it's resources.
Call only when the variable or argument is going out of scope.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getExpression()"><!-- --></A><H3>
getExpression</H3>
<PRE>
public java.lang.String <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.117"><B>getExpression</B></A>()</PRE>
<DL>
<DD>Get the value expression for this argument.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>String containing the expression previously stored into this
argument<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#setExpression(java.lang.String)"><CODE>setExpression(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setExpression(java.lang.String)"><!-- --></A><H3>
setExpression</H3>
<PRE>
public void <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.129"><B>setExpression</B></A>(java.lang.String&nbsp;expr)</PRE>
<DL>
<DD>Set the value expression for this argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expr</CODE> - String containing the expression to be stored as this
argument's value.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/xpath/Arg.html#getExpression()"><CODE>getExpression()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isFromWithParam()"><!-- --></A><H3>
isFromWithParam</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.144"><B>isFromWithParam</B></A>()</PRE>
<DL>
<DD>Tell if this variable is a parameter passed with a with-param or as
a top-level parameter.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isVisible()"><!-- --></A><H3>
isVisible</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.161"><B>isVisible</B></A>()</PRE>
<DL>
<DD>Tell if this variable is currently visible.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setIsVisible(boolean)"><!-- --></A><H3>
setIsVisible</H3>
<PRE>
public void <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.169"><B>setIsVisible</B></A>(boolean&nbsp;b)</PRE>
<DL>
<DD>Update visibility status of this variable.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/apache/xpath/Arg.html#line.232"><B>equals</B></A>(java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Equality function specialized for the variable name. If the argument
is not a qname, it will deligate to the super class.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
<DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</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/Arg.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../org/apache/xpath/CachedXPathAPI.html" title="class in org.apache.xpath"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/apache/xpath/Arg.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Arg.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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>