blob: 4fb0896fc5dfd45256c6a7bf3c7f02743ab45d10 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XNull Class Reference</h1><code>#include &lt;<a class="el" href="XNull_8hpp-source.html">XNull.hpp</a>&gt;</code>
<p>
Inheritance diagram for XNull:<p><center><img src="classXNull__inherit__graph.gif" border="0" usemap="#XNull_inherit_map" alt="Inheritance graph"></center>
<map name="XNull_inherit_map">
<area href="classXObject.html" shape="rect" coords="72,117,138,93">
<area href="classXalanReferenceCountedObject.html" shape="rect" coords="6,42,204,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XNull:<p><center><img src="classXNull__coll__graph.gif" border="0" usemap="#XNull_coll_map" alt="Collaboration graph"></center>
<map name="XNull_coll_map">
<area href="classXObject.html" shape="rect" coords="300,234,366,210">
<area href="classXalanReferenceCountedObject.html" shape="rect" coords="6,42,204,18">
<area href="classXalanDOMString.html" shape="rect" coords="442,42,559,18">
<area href="classXObjectFactory.html" shape="rect" coords="228,42,337,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXNull-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXObject.html">XObject</a> <a class="el" href="classXNull.html#s0">ParentType</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXNull.html#a0">XNull</a> ()
<dl class="el"><dd><font size=-1><em>Create an XNull.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXNull.html#a1">XNull</a> (const XNull &amp;source)
<dl class="el"><dd><font size=-1><em>Create an XNull from another.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXNull.html#a2">~XNull</a> ()
<li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXNull.html#a3">getTypeString</a> () const
<dl class="el"><dd><font size=-1><em>Given a request type, return the equivalent string.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual double <a class="el" href="classXNull.html#a4">num</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a number.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXNull.html#a5">boolean</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a boolean.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXNull.html#a6">str</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a string.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXNull.html#a7">str</a> (<a class="el" href="classFormatterListener.html">FormatterListener</a> &amp;formatterListener, <a class="el" href="classXObject.html#s0">MemberFunctionPtr</a> function) const
<dl class="el"><dd><font size=-1><em>Send the string value to a <a class="el" href="classFormatterListener.html">FormatterListener</a> instance.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>virtual double <a class="el" href="classXNull.html#a8">stringLength</a> () const
<dl class="el"><dd><font size=-1><em>Get the length of the string value of the instance..</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXNull.html#a9">ProcessXObjectTypeCallback</a> (<a class="el" href="classXObjectTypeCallback.html">XObjectTypeCallback</a> &amp;theCallbackObject)
<dl class="el"><dd><font size=-1><em>Process a callback request for preferred type information.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXNull.html#a10">ProcessXObjectTypeCallback</a> (<a class="el" href="classXObjectTypeCallback.html">XObjectTypeCallback</a> &amp;theCallbackObject) const
<dl class="el"><dd><font size=-1><em>Process a callback request for preferred type information.</em> <a href="#a10">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Methods</h2>
<ul>
<li>void <a class="el" href="classXNull.html#d0">initialize</a> ()
<dl class="el"><dd><font size=-1><em>Perform static initialization.</em> <a href="#d0">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXNull.html#d1">terminate</a> ()
<dl class="el"><dd><font size=-1><em>Perform static shut down.</em> <a href="#d1">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XNull::ParentType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef <a class="el" href="classXObject.html">XObject</a> XNull::ParentType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XNull::XNull"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNull::XNull (
</b></td>
<td valign="bottom"><b>
)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create an XNull.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="XNull::XNull"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNull::XNull (
</b></td>
<td valign="bottom"><b>
const XNull &amp; <em>source</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create an XNull from another.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em>
&nbsp;</td><td>
object to copy </td></tr>
<tr><td valign=top><em>deepClone</em>
&nbsp;</td><td>
true to copy all children on nodeset nodes </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="XNull::~XNull"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNull::~XNull (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a10" doxytag="XNull::ProcessXObjectTypeCallback"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNull::ProcessXObjectTypeCallback (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXObjectTypeCallback.html">XObjectTypeCallback</a> &amp; <em>theCallbackObject</em>&nbsp;) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Process a callback request for preferred type information.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theCallbackObject</em>
&nbsp;</td><td>
object to call back </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a12">XObject</a>. </td>
</tr>
</table>
<a name="a9" doxytag="XNull::ProcessXObjectTypeCallback"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNull::ProcessXObjectTypeCallback (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXObjectTypeCallback.html">XObjectTypeCallback</a> &amp; <em>theCallbackObject</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Process a callback request for preferred type information.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theCallbackObject</em>
&nbsp;</td><td>
object to call back </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a11">XObject</a>. </td>
</tr>
</table>
<a name="a5" doxytag="XNull::boolean"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XNull::boolean (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cast result object to a boolean.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
boolean value </dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a4">XObject</a>. </td>
</tr>
</table>
<a name="a3" doxytag="XNull::getTypeString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XNull::getTypeString (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Given a request type, return the equivalent string.
<p>
For diagnostic purposes.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
string for type </dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a2">XObject</a>. </td>
</tr>
</table>
<a name="d0" doxytag="XNull::initialize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNull::initialize (
</b></td>
<td valign="bottom"><b>
)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform static initialization.
<p>
See class <a class="el" href="classXPathInit.html">XPathInit</a>. </td>
</tr>
</table>
<a name="a4" doxytag="XNull::num"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
double XNull::num (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cast result object to a number.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
numeric value </dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a3">XObject</a>. </td>
</tr>
</table>
<a name="a7" doxytag="XNull::str"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNull::str (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classFormatterListener.html">FormatterListener</a> &amp; <em>formatterListener</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXObject.html#s0">MemberFunctionPtr</a> <em>function</em>&nbsp;) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Send the string value to a <a class="el" href="classFormatterListener.html">FormatterListener</a> instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>formatterListener</em>
&nbsp;</td><td>
The <a class="el" href="classFormatterListener.html">FormatterListener</a> instance </td></tr>
<tr><td valign=top><em>function</em>
&nbsp;</td><td>
A pointer to the member function of <a class="el" href="classFormatterListener.html">FormatterListener</a> to call </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a6">XObject</a>. </td>
</tr>
</table>
<a name="a6" doxytag="XNull::str"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XNull::str (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cast result object to a string.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
string value </dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a5">XObject</a>. </td>
</tr>
</table>
<a name="a8" doxytag="XNull::stringLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
double XNull::stringLength (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the length of the string value of the instance..
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The length of the string value </dl>
<p>
Reimplemented from <a class="el" href="classXObject.html#a7">XObject</a>. </td>
</tr>
</table>
<a name="d1" doxytag="XNull::terminate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNull::terminate (
</b></td>
<td valign="bottom"><b>
)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform static shut down.
<p>
See class <a class="el" href="classXPathInit.html">XPathInit</a>.
<p>
Reimplemented from <a class="el" href="classXObject.html#d1">XObject</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XNull_8hpp-source.html">XNull.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>