Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXPathGuard.html
blob: 4061fc8b85f7d69a548cfdd47640db82c35c7d7a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XPathGuard Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XPathGuard" -->
<p>Manages the lifetime of an <a class="el" href="classXPath.html">XPath</a> instance.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XPathGuard:</div>
<div class="dyncontent">
<div class="center"><img src="classXPathGuard__coll__graph.png" border="0" usemap="#XPathGuard_coll__map" alt="Collaboration graph"/></div>
<map name="XPathGuard_coll__map" id="XPathGuard_coll__map">
<area shape="rect" id="node2" href="classXPathFactory.html" title="XPathFactory" alt="" coords="1136,160,1243,189"/><area shape="rect" id="node4" href="classXPath.html" title="XPath" alt="" coords="1159,213,1220,243"/><area shape="rect" id="node6" href="classXPathFunctionTable.html" title="Class defines a table of functions that can be called in XPath expresions." alt="" coords="849,83,996,112"/><area shape="rect" id="node8" href="classFunction.html" title="Function" alt="" coords="453,17,528,47"/><area shape="rect" id="node10" href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" title="XPathFunctionTable::FunctionNameTableEntry" alt="" coords="333,83,648,112"/><area shape="rect" id="node12" href="classXPathExpression.html" title="XPathExpression" alt="" coords="857,213,988,243"/><area shape="rect" id="node14" href="classXalanVector.html" title="XalanVector\&lt; XToken \&gt;" alt="" coords="403,136,579,165"/><area shape="rect" id="node16" href="classXalanVector.html" title="XalanVector\&lt; int \&gt;" alt="" coords="417,189,564,219"/><area shape="rect" id="node18" href="classXalanVector.html" title="XalanVector\&lt; double \&gt;" alt="" coords="404,243,577,272"/><area shape="rect" id="node20" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="427,313,555,343"/><area shape="rect" id="node22" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,313,233,343"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXPathGuard-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXPathGuard.html#af874661f375811a278f9eebc0a4d3e6e">XPathGuard</a> (<a class="el" href="classXPathFactory.html">XPathFactory</a> &amp;theFactory, const <a class="el" href="classXPath.html">XPath</a> *theXPath)
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classXPathGuard.html" title="Manages the lifetime of an XPath instance.">XPathGuard</a> instance from a factory object and an <a class="el" href="classXPath.html">XPath</a>. <a href="#af874661f375811a278f9eebc0a4d3e6e"></a><br/></dl><li><a class="el" href="classXPathGuard.html#aea649414169513bb6928268d255b5061">XPathGuard</a> (<a class="el" href="classXPathGuard.html">XPathGuard</a> &amp;theRHS)
<li><a class="el" href="classXPathGuard.html#addcf87c5cb54dd32707dbaef5f63d87f">~XPathGuard</a> ()
<li>const <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classXPathGuard.html#a85ef92436127d0c85ff78871ba72d37e">operator-&gt;</a> () const
<dl class="el"><dd class="mdescRight">Retrieve the object pointer (must not be null). <a href="#a85ef92436127d0c85ff78871ba72d37e"></a><br/></dl><li>const <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classXPathGuard.html#a3e9e581c9979cfabe0b3388fff9abe30">get</a> () const
<dl class="el"><dd class="mdescRight">Retrieve the object pointer (may be null). <a href="#a3e9e581c9979cfabe0b3388fff9abe30"></a><br/></dl><li>void <a class="el" href="classXPathGuard.html#a8ee642c9fe9c9b054f07b0eb73b25e4a">reset</a> ()
<dl class="el"><dd class="mdescRight">Return the referenced object to the factory and set pointers to null. <a href="#a8ee642c9fe9c9b054f07b0eb73b25e4a"></a><br/></dl><li>const <a class="el" href="classXPath.html">XPath</a> * <a class="el" href="classXPathGuard.html#a12b6338027daf997027cb1cb6956ee78">release</a> ()
<dl class="el"><dd class="mdescRight">Transfers ownership of <a class="el" href="classXPath.html">XPath</a> to caller. <a href="#a12b6338027daf997027cb1cb6956ee78"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Manages the lifetime of an <a class="el" href="classXPath.html">XPath</a> instance. </p>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00135">135</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af874661f375811a278f9eebc0a4d3e6e"></a><!-- doxytag: member="XPathGuard::XPathGuard" ref="af874661f375811a278f9eebc0a4d3e6e" args="(XPathFactory &amp;theFactory, const XPath *theXPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathGuard::XPathGuard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathFactory.html">XPathFactory</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theFactory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXPath.html">XPath</a> *&nbsp;</td>
<td class="paramname"> <em>theXPath</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an <a class="el" href="classXPathGuard.html" title="Manages the lifetime of an XPath instance.">XPathGuard</a> instance from a factory object and an <a class="el" href="classXPath.html">XPath</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theFactory</em>&nbsp;</td><td>object that manages lifetime of XPaths </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theXPath</em>&nbsp;</td><td>pointer to <a class="el" href="classXPath.html">XPath</a> managed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00145">145</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aea649414169513bb6928268d255b5061"></a><!-- doxytag: member="XPathGuard::XPathGuard" ref="aea649414169513bb6928268d255b5061" args="(XPathGuard &amp;theRHS)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathGuard::XPathGuard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathGuard.html">XPathGuard</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theRHS</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00155">155</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="addcf87c5cb54dd32707dbaef5f63d87f"></a><!-- doxytag: member="XPathGuard::~XPathGuard" ref="addcf87c5cb54dd32707dbaef5f63d87f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathGuard::~XPathGuard </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00170">170</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3e9e581c9979cfabe0b3388fff9abe30"></a><!-- doxytag: member="XPathGuard::get" ref="a3e9e581c9979cfabe0b3388fff9abe30" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXPath.html">XPath</a>* XPathGuard::get </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the object pointer (may be null). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to <a class="el" href="classXPath.html">XPath</a> </dd></dl>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00194">194</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a85ef92436127d0c85ff78871ba72d37e"></a><!-- doxytag: member="XPathGuard::operator&#45;&gt;" ref="a85ef92436127d0c85ff78871ba72d37e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXPath.html">XPath</a>* XPathGuard::operator-&gt; </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the object pointer (must not be null). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to <a class="el" href="classXPath.html">XPath</a> </dd></dl>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00181">181</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a12b6338027daf997027cb1cb6956ee78"></a><!-- doxytag: member="XPathGuard::release" ref="a12b6338027daf997027cb1cb6956ee78" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXPath.html">XPath</a>* XPathGuard::release </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transfers ownership of <a class="el" href="classXPath.html">XPath</a> to caller. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to <a class="el" href="classXPath.html">XPath</a> </dd></dl>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00223">223</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8ee642c9fe9c9b054f07b0eb73b25e4a"></a><!-- doxytag: member="XPathGuard::reset" ref="a8ee642c9fe9c9b054f07b0eb73b25e4a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XPathGuard::reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the referenced object to the factory and set pointers to null. </p>
<p>Definition at line <a class="el" href="XPathFactory_8hpp_source.html#l00203">203</a> of file <a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathFactory_8hpp_source.html">XPathFactory.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>