/usr/share/doc/libcommons-configuration-java/api/org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html is in libcommons-configuration-java-doc 1.10-1.
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 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 | <!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.7.0_25) on Sat Nov 02 11:15:07 UTC 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>XMLBeanDeclaration (Apache Commons Configuration 1.10 API)</title>
<meta name="date" content="2013-11-02">
<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="XMLBeanDeclaration (Apache Commons Configuration 1.10 API)";
}
//-->
</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="class-use/XMLBeanDeclaration.html">Use</a></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/configuration/beanutils/DefaultBeanFactory.html" title="class in org.apache.commons.configuration.beanutils"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html" target="_top">Frames</a></li>
<li><a href="XMLBeanDeclaration.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="#field_summary">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><a href="#field_detail">Field</a> | </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">
<div class="subTitle">org.apache.commons.configuration.beanutils</div>
<h2 title="Class XMLBeanDeclaration" class="title">Class XMLBeanDeclaration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.configuration.beanutils.XMLBeanDeclaration</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/commons/configuration/DefaultConfigurationBuilder.ConfigurationDeclaration.html" title="class in org.apache.commons.configuration">DefaultConfigurationBuilder.ConfigurationDeclaration</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">XMLBeanDeclaration</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></pre>
<div class="block"><p>
An implementation of the <code>BeanDeclaration</code> interface that is
suitable for XML configuration files.
</p>
<p>
This class defines the standard layout of a bean declaration in an XML
configuration file. Such a declaration must look like the following example
fragment:
</p>
<p>
<pre>
...
<personBean config-class="my.model.PersonBean"
lastName="Doe" firstName="John">
<address config-class="my.model.AddressBean"
street="21st street 11" zip="1234"
city="TestCity"/>
</personBean>
</pre>
</p>
<p>
The bean declaration can be contained in an arbitrary element. Here it is the
<code>personBean</code> element. In the attributes of this element
there can occur some reserved attributes, which have the following meaning:
<dl>
<dt><code>config-class</code></dt>
<dd>Here the full qualified name of the bean's class can be specified. An
instance of this class will be created. If this attribute is not specified,
the bean class must be provided in another way, e.g. as the
<code>defaultClass</code> passed to the <code>BeanHelper</code> class.</dd>
<dt><code>config-factory</code></dt>
<dd>This attribute can contain the name of the
<a href="../../../../../org/apache/commons/configuration/beanutils/BeanFactory.html" title="interface in org.apache.commons.configuration.beanutils"><code>BeanFactory</code></a> that should be used for creating the bean.
If it is defined, a factory with this name must have been registered at the
<code>BeanHelper</code> class. If this attribute is missing, the default
bean factory will be used.</dd>
<dt><code>config-factoryParam</code></dt>
<dd>With this attribute a parameter can be specified that will be passed to
the bean factory. This may be useful for custom bean factories.</dd>
</dl>
</p>
<p>
All further attributes starting with the <code>config-</code> prefix are
considered as meta data and will be ignored. All other attributes are treated
as properties of the bean to be created, i.e. corresponding setter methods of
the bean will be invoked with the values specified here.
</p>
<p>
If the bean to be created has also some complex properties (which are itself
beans), their values cannot be initialized from attributes. For this purpose
nested elements can be used. The example listing shows how an address bean
can be initialized. This is done in a nested element whose name must match
the name of a property of the enclosing bean declaration. The format of this
nested element is exactly the same as for the bean declaration itself, i.e.
it can have attributes defining meta data or bean properties and even further
nested elements for complex bean properties.
</p>
<p>
A <code>XMLBeanDeclaration</code> object is usually created from a
<code>HierarchicalConfiguration</code>. From this it will derive a
<code>SubnodeConfiguration</code>, which is used to access the needed
properties. This subnode configuration can be obtained using the
<a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getConfiguration()"><code>getConfiguration()</code></a> method. All of its properties can
be accessed in the usual way. To ensure that the property keys used by this
class are understood by the configuration, the default expression engine will
be set.
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.3</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: XMLBeanDeclaration.java 1301959 2012-03-17 16:43:18Z oheger $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a
href="http://commons.apache.org/configuration/team-list.html">Commons
Configuration team</a></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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#ATTR_BEAN_CLASS">ATTR_BEAN_CLASS</a></strong></code>
<div class="block">Constant for the bean class attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#ATTR_BEAN_FACTORY">ATTR_BEAN_FACTORY</a></strong></code>
<div class="block">Constant for the bean factory attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#ATTR_FACTORY_PARAM">ATTR_FACTORY_PARAM</a></strong></code>
<div class="block">Constant for the bean factory parameter attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#ATTR_PREFIX">ATTR_PREFIX</a></strong></code>
<div class="block">Constant for the prefix for reserved attributes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#RESERVED_PREFIX">RESERVED_PREFIX</a></strong></code>
<div class="block">Constant for the prefix of reserved attributes.</div>
</td>
</tr>
</table>
</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/configuration/beanutils/XMLBeanDeclaration.html#XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration)">XMLBeanDeclaration</a></strong>(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config)</code>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration, java.lang.String)">XMLBeanDeclaration</a></strong>(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration, java.lang.String, boolean)">XMLBeanDeclaration</a></strong>(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key,
boolean optional)</code>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#XMLBeanDeclaration(org.apache.commons.configuration.SubnodeConfiguration, org.apache.commons.configuration.tree.ConfigurationNode)">XMLBeanDeclaration</a></strong>(<a href="../../../../../org/apache/commons/configuration/SubnodeConfiguration.html" title="class in org.apache.commons.configuration">SubnodeConfiguration</a> config,
<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> node)</code>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it with the configuration node that contains the bean
declaration.</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>protected <a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#createBeanDeclaration(org.apache.commons.configuration.tree.ConfigurationNode)">createBeanDeclaration</a></strong>(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> node)</code>
<div class="block">Creates a new <code>BeanDeclaration</code> for a child node of the
current configuration node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getBeanClassName()">getBeanClassName</a></strong>()</code>
<div class="block">Returns the name of the class of the bean to be created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getBeanFactoryName()">getBeanFactoryName</a></strong>()</code>
<div class="block">Returns the name of the bean factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getBeanFactoryParameter()">getBeanFactoryParameter</a></strong>()</code>
<div class="block">Returns a parameter for the bean factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getBeanProperties()">getBeanProperties</a></strong>()</code>
<div class="block">Returns a map with the bean's (simple) properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/configuration/SubnodeConfiguration.html" title="class in org.apache.commons.configuration">SubnodeConfiguration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">Returns the configuration object this bean declaration is based on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getNestedBeanDeclarations()">getNestedBeanDeclarations</a></strong>()</code>
<div class="block">Returns a map with bean declarations for the complex properties of the
bean to be created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#getNode()">getNode</a></strong>()</code>
<div class="block">Returns the node that contains the bean declaration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#interpolate(java.lang.Object)">interpolate</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
<div class="block">Performs interpolation for the specified value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html#isReservedNode(org.apache.commons.configuration.tree.ConfigurationNode)">isReservedNode</a></strong>(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> nd)</code>
<div class="block">Checks if the specified node is reserved and thus should be ignored.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="RESERVED_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RESERVED_PREFIX</h4>
<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RESERVED_PREFIX</pre>
<div class="block">Constant for the prefix of reserved attributes.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.configuration.beanutils.XMLBeanDeclaration.RESERVED_PREFIX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ATTR_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTR_PREFIX</h4>
<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTR_PREFIX</pre>
<div class="block">Constant for the prefix for reserved attributes.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.configuration.beanutils.XMLBeanDeclaration.ATTR_PREFIX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ATTR_BEAN_CLASS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTR_BEAN_CLASS</h4>
<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTR_BEAN_CLASS</pre>
<div class="block">Constant for the bean class attribute.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.configuration.beanutils.XMLBeanDeclaration.ATTR_BEAN_CLASS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ATTR_BEAN_FACTORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTR_BEAN_FACTORY</h4>
<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTR_BEAN_FACTORY</pre>
<div class="block">Constant for the bean factory attribute.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.configuration.beanutils.XMLBeanDeclaration.ATTR_BEAN_FACTORY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ATTR_FACTORY_PARAM">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ATTR_FACTORY_PARAM</h4>
<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTR_FACTORY_PARAM</pre>
<div class="block">Constant for the bean factory parameter attribute.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.configuration.beanutils.XMLBeanDeclaration.ATTR_FACTORY_PARAM">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XMLBeanDeclaration</h4>
<pre>public XMLBeanDeclaration(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration. The passed in key points to
the bean declaration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the configuration</dd><dd><code>key</code> - the key to the bean declaration (this key must point to
exactly one bean declaration or a <code>IllegalArgumentException</code>
exception will be thrown)</dd></dl>
</li>
</ul>
<a name="XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XMLBeanDeclaration</h4>
<pre>public XMLBeanDeclaration(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key,
boolean optional)</pre>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration. The passed in key points to
the bean declaration. If the key does not exist and the boolean argument
is <b>true</b>, the declaration is initialized with an empty
configuration. It is possible to create objects from such an empty
declaration if a default class is provided. If the key on the other hand
has multiple values or is undefined and the boolean argument is <b>false</b>,
a <code>IllegalArgumentException</code> exception will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the configuration</dd><dd><code>key</code> - the key to the bean declaration</dd><dd><code>optional</code> - a flag whether this declaration is optional; if set to
<b>true</b>, no exception will be thrown if the passed in key is
undefined</dd></dl>
</li>
</ul>
<a name="XMLBeanDeclaration(org.apache.commons.configuration.HierarchicalConfiguration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XMLBeanDeclaration</h4>
<pre>public XMLBeanDeclaration(<a href="../../../../../org/apache/commons/configuration/HierarchicalConfiguration.html" title="class in org.apache.commons.configuration">HierarchicalConfiguration</a> config)</pre>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it from the given configuration. The configuration's root
node must contain the bean declaration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the configuration with the bean declaration</dd></dl>
</li>
</ul>
<a name="XMLBeanDeclaration(org.apache.commons.configuration.SubnodeConfiguration, org.apache.commons.configuration.tree.ConfigurationNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XMLBeanDeclaration</h4>
<pre>public XMLBeanDeclaration(<a href="../../../../../org/apache/commons/configuration/SubnodeConfiguration.html" title="class in org.apache.commons.configuration">SubnodeConfiguration</a> config,
<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> node)</pre>
<div class="block">Creates a new instance of <code>XMLBeanDeclaration</code> and
initializes it with the configuration node that contains the bean
declaration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the configuration</dd><dd><code>node</code> - the node with the bean declaration.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre>public <a href="../../../../../org/apache/commons/configuration/SubnodeConfiguration.html" title="class in org.apache.commons.configuration">SubnodeConfiguration</a> getConfiguration()</pre>
<div class="block">Returns the configuration object this bean declaration is based on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the associated configuration</dd></dl>
</li>
</ul>
<a name="getNode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre>public <a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> getNode()</pre>
<div class="block">Returns the node that contains the bean declaration.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the configuration node this bean declaration is based on</dd></dl>
</li>
</ul>
<a name="getBeanFactoryName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeanFactoryName</h4>
<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBeanFactoryName()</pre>
<div class="block">Returns the name of the bean factory. This information is fetched from
the <code>config-factory</code> attribute.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html#getBeanFactoryName()">getBeanFactoryName</a></code> in interface <code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the name of the bean factory</dd></dl>
</li>
</ul>
<a name="getBeanFactoryParameter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeanFactoryParameter</h4>
<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getBeanFactoryParameter()</pre>
<div class="block">Returns a parameter for the bean factory. This information is fetched
from the <code>config-factoryParam</code> attribute.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html#getBeanFactoryParameter()">getBeanFactoryParameter</a></code> in interface <code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the parameter for the bean factory</dd></dl>
</li>
</ul>
<a name="getBeanClassName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeanClassName</h4>
<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBeanClassName()</pre>
<div class="block">Returns the name of the class of the bean to be created. This information
is obtained from the <code>config-class</code> attribute.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html#getBeanClassName()">getBeanClassName</a></code> in interface <code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the name of the bean's class</dd></dl>
</li>
</ul>
<a name="getBeanProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeanProperties</h4>
<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getBeanProperties()</pre>
<div class="block">Returns a map with the bean's (simple) properties. The properties are
collected from all attribute nodes, which are not reserved.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html#getBeanProperties()">getBeanProperties</a></code> in interface <code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a map with the bean's properties</dd></dl>
</li>
</ul>
<a name="getNestedBeanDeclarations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNestedBeanDeclarations</h4>
<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getNestedBeanDeclarations()</pre>
<div class="block">Returns a map with bean declarations for the complex properties of the
bean to be created. These declarations are obtained from the child nodes
of this declaration's root node.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html#getNestedBeanDeclarations()">getNestedBeanDeclarations</a></code> in interface <code><a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a map with bean declarations for complex properties</dd></dl>
</li>
</ul>
<a name="interpolate(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interpolate</h4>
<pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> interpolate(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre>
<div class="block">Performs interpolation for the specified value. This implementation will
interpolate against the current subnode configuration's parent. If sub
classes need a different interpolation mechanism, they should override
this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value that is to be interpolated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the interpolated value</dd></dl>
</li>
</ul>
<a name="isReservedNode(org.apache.commons.configuration.tree.ConfigurationNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReservedNode</h4>
<pre>protected boolean isReservedNode(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> nd)</pre>
<div class="block">Checks if the specified node is reserved and thus should be ignored. This
method is called when the maps for the bean's properties and complex
properties are collected. It checks whether the given node is an
attribute node and if its name starts with the reserved prefix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nd</code> - the node to be checked</dd>
<dt><span class="strong">Returns:</span></dt><dd>a flag whether this node is reserved (and does not point to a
property)</dd></dl>
</li>
</ul>
<a name="createBeanDeclaration(org.apache.commons.configuration.tree.ConfigurationNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createBeanDeclaration</h4>
<pre>protected <a href="../../../../../org/apache/commons/configuration/beanutils/BeanDeclaration.html" title="interface in org.apache.commons.configuration.beanutils">BeanDeclaration</a> createBeanDeclaration(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html" title="interface in org.apache.commons.configuration.tree">ConfigurationNode</a> node)</pre>
<div class="block">Creates a new <code>BeanDeclaration</code> for a child node of the
current configuration node. This method is called by
<code>getNestedBeanDeclarations()</code> for all complex sub properties
detected by this method. Derived classes can hook in if they need a
specific initialization. This base implementation creates a
<code>XMLBeanDeclaration</code> that is properly initialized from the
passed in node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the child node, for which a <code>BeanDeclaration</code> is
to be created</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>BeanDeclaration</code> for this child node</dd><dt><span class="strong">Since:</span></dt>
<dd>1.6</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="class-use/XMLBeanDeclaration.html">Use</a></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/configuration/beanutils/DefaultBeanFactory.html" title="class in org.apache.commons.configuration.beanutils"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html" target="_top">Frames</a></li>
<li><a href="XMLBeanDeclaration.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="#field_summary">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><a href="#field_detail">Field</a> | </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-2013. All Rights Reserved.</small></p>
</body>
</html>
|