/usr/share/doc/libcommons-digester-java-doc/api/org/apache/commons/digester/plugins/PluginDeclarationRule.html is in libcommons-digester-java-doc 1.8.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Tue Aug 06 00:29:48 CEST 2013 -->
<title>PluginDeclarationRule (Digester - XML to Java Object Configuration (Version 1.8.1))</title>
<meta name="date" content="2013-08-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PluginDeclarationRule (Digester - XML to Java Object Configuration (Version 1.8.1))";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/digester/plugins/PluginCreateRule.html" title="class in org.apache.commons.digester.plugins"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/commons/digester/plugins/PluginException.html" title="class in org.apache.commons.digester.plugins"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/digester/plugins/PluginDeclarationRule.html" target="_top">FRAMES</a></li>
<li><a href="PluginDeclarationRule.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li>NESTED | </li>
<li><a href="#fields_inherited_from_class_org.apache.commons.digester.Rule">FIELD</a> | </li>
<li><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li><a href="#constructor_detail">CONSTR</a> | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.commons.digester.plugins</p>
<h2 title="Class PluginDeclarationRule" class="title">Class PluginDeclarationRule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/commons/digester/Rule.html" title="class in org.apache.commons.digester">org.apache.commons.digester.Rule</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.digester.plugins.PluginDeclarationRule</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>PluginDeclarationRule</strong>
extends <a href="../../../../../org/apache/commons/digester/Rule.html" title="class in org.apache.commons.digester">Rule</a></pre>
<div class="block">A Digester rule which allows the user to pre-declare a class which is to
be referenced later at a plugin point by a PluginCreateRule.
<p>
Normally, a PluginDeclarationRule is added to a Digester instance with
the pattern "{root}/plugin" or "* /plugin" where {root} is the name of
the root tag in the input document.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.digester.Rule">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.commons.digester.<a href="../../../../../org/apache/commons/digester/Rule.html" title="class in org.apache.commons.digester">Rule</a></h3>
<code><a href="../../../../../org/apache/commons/digester/Rule.html#digester">digester</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#namespaceURI">namespaceURI</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/digester/plugins/PluginDeclarationRule.html#PluginDeclarationRule()">PluginDeclarationRule</a></strong>()</code>
<div class="block">constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/digester/plugins/PluginDeclarationRule.html#begin(java.lang.String, java.lang.String, org.xml.sax.Attributes)">begin</a></strong>(java.lang.String namespace,
java.lang.String name,
org.xml.sax.Attributes attributes)</code>
<div class="block">Invoked upon reading a tag defining a plugin declaration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/digester/plugins/PluginDeclarationRule.html#declarePlugin(org.apache.commons.digester.Digester, java.util.Properties)">declarePlugin</a></strong>(<a href="../../../../../org/apache/commons/digester/Digester.html" title="class in org.apache.commons.digester">Digester</a> digester,
java.util.Properties props)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.digester.Rule">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.commons.digester.<a href="../../../../../org/apache/commons/digester/Rule.html" title="class in org.apache.commons.digester">Rule</a></h3>
<code><a href="../../../../../org/apache/commons/digester/Rule.html#begin(org.xml.sax.Attributes)">begin</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#body(java.lang.String)">body</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#body(java.lang.String, java.lang.String, java.lang.String)">body</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#end()">end</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#end(java.lang.String, java.lang.String)">end</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#finish()">finish</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#getDigester()">getDigester</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#getNamespaceURI()">getNamespaceURI</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#setDigester(org.apache.commons.digester.Digester)">setDigester</a>, <a href="../../../../../org/apache/commons/digester/Rule.html#setNamespaceURI(java.lang.String)">setNamespaceURI</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PluginDeclarationRule()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PluginDeclarationRule</h4>
<pre>public PluginDeclarationRule()</pre>
<div class="block">constructor</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="begin(java.lang.String, java.lang.String, org.xml.sax.Attributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>begin</h4>
<pre>public void begin(java.lang.String namespace,
java.lang.String name,
org.xml.sax.Attributes attributes)
throws java.lang.Exception</pre>
<div class="block">Invoked upon reading a tag defining a plugin declaration. The tag
must have the following mandatory attributes:
<ul>
<li> id </li>
<li> class </li>
</ul></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/digester/Rule.html#begin(java.lang.String, java.lang.String, org.xml.sax.Attributes)">begin</a></code> in class <code><a href="../../../../../org/apache/commons/digester/Rule.html" title="class in org.apache.commons.digester">Rule</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - The xml namespace in which the xml element which
triggered this rule resides.</dd><dd><code>name</code> - The name of the xml element which triggered this rule.</dd><dd><code>attributes</code> - The set of attributes on the xml element which
triggered this rule.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd></dl>
</li>
</ul>
<a name="declarePlugin(org.apache.commons.digester.Digester, java.util.Properties)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>declarePlugin</h4>
<pre>public static void declarePlugin(<a href="../../../../../org/apache/commons/digester/Digester.html" title="class in org.apache.commons.digester">Digester</a> digester,
java.util.Properties props)
throws <a href="../../../../../org/apache/commons/digester/plugins/PluginException.html" title="class in org.apache.commons.digester.plugins">PluginException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/digester/plugins/PluginException.html" title="class in org.apache.commons.digester.plugins">PluginException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/digester/plugins/PluginCreateRule.html" title="class in org.apache.commons.digester.plugins"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/commons/digester/plugins/PluginException.html" title="class in org.apache.commons.digester.plugins"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/digester/plugins/PluginDeclarationRule.html" target="_top">FRAMES</a></li>
<li><a href="PluginDeclarationRule.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li>NESTED | </li>
<li><a href="#fields_inherited_from_class_org.apache.commons.digester.Rule">FIELD</a> | </li>
<li><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li><a href="#constructor_detail">CONSTR</a> | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright 2001-2005 The Apache Software Foundation.</small></p>
</body>
</html>
|