/usr/share/doc/libavalon-framework-java-doc/api/org/apache/avalon/framework/configuration/Configuration.html is in libavalon-framework-java-doc 4.2.0-10.
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 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>Configuration</title>
<meta name="date" content="2017-10-30">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Configuration";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/avalon/framework/configuration/Configurable.html" title="interface in org.apache.avalon.framework.configuration"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/avalon/framework/configuration/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.avalon.framework.configuration</div>
<h2 title="Interface Configuration" class="title">Interface Configuration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/avalon/framework/configuration/MutableConfiguration.html" title="interface in org.apache.avalon.framework.configuration">MutableConfiguration</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/avalon/framework/configuration/AbstractConfiguration.html" title="class in org.apache.avalon.framework.configuration">AbstractConfiguration</a>, <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfiguration.html" title="class in org.apache.avalon.framework.configuration">DefaultConfiguration</a>, <a href="../../../../../org/apache/avalon/framework/configuration/DefaultImmutableConfiguration.html" title="class in org.apache.avalon.framework.configuration">DefaultImmutableConfiguration</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Configuration</span></pre>
<div class="block"><code>Configuration</code> is a interface encapsulating a configuration node
used to retrieve configuration values.
<p>
This is a "read only" interface preventing applications from modifying their
own configurations. Once it is created, the information never changes.
</p>
<h3>Data Model</h3>
<p>
The data model is a subset of XML's; a single-rooted hierarchical tree where each
node can contain multiple <em>attributes</em>, and leaf nodes can also
contain a <em>value</em>. Reflecting this, <code>Configuration</code>s are
usually built from an XML file by the <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.html" title="class in org.apache.avalon.framework.configuration"><code>DefaultConfigurationBuilder</code></a>
class, or directly by a SAX parser using a <a href="../../../../../org/apache/avalon/framework/configuration/SAXConfigurationHandler.html" title="class in org.apache.avalon.framework.configuration"><code>SAXConfigurationHandler</code></a> or
<a href="../../../../../org/apache/avalon/framework/configuration/NamespacedSAXConfigurationHandler.html" title="class in org.apache.avalon.framework.configuration"><code>NamespacedSAXConfigurationHandler</code></a> event handler.
</p>
<h4>Namespace support</h4>
<p>
Since version 4.1, each <code>Configuration</code> node has a namespace
associated with it, in the form of a string, accessible through <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getNamespace--"><code>getNamespace()</code></a>. If no namespace is present, <code>getNamespace</code> will
return blank (""). See <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.html" title="class in org.apache.avalon.framework.configuration"><code>DefaultConfigurationBuilder</code></a> for details on how
XML namespaces are mapped to <code>Configuration</code> namespaces.
</p>
<h3>Example</h3>
<p>
As an example, consider two <code>Configuration</code>s (with and without
namespaces) built from this XML:
</p>
<pre>
<my-system version="1.3" xmlns:doc="http://myco.com/documentation">
<doc:desc>This is a highly fictitious config file</doc:desc>
<widget name="fooWidget" initOrder="1" threadsafe="true"/>
</my-system>
</pre>
<p>If namespace support is enabled (eg through <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.html#DefaultConfigurationBuilder-boolean-"><code>new
DefaultConfigurationBuilder(true)</code></a>), then the <code>xmlns:doc</code> element
will not translate into a Configuration attribute, and the
<code>doc:desc</code> element will become a <code>Configuration</code> node
with name "desc" and namespace "http://myco.com/documentation". The
<code>widget</code> element will have namespace "".
</p>
<p>If namespace support is disabled (the default for <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.html" title="class in org.apache.avalon.framework.configuration"><code>DefaultConfigurationBuilder</code></a>), the above XML will translate directly to
<code>Configuration</code> nodes. The <code>my-system</code> node will have
an attribute named "xmlns:doc", and a child called "doc:desc".
</p>
<p>
Assuming the <code>Configuration</code> object is named <code>conf</code>,
here is how the data could be retrieved:
</p>
<table border="1">
<tr align="center"><th>Code</th><th>No namespaces</th><th>With namespaces</th></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getName--"><code>getName</code></a>()</code></td><td colspan="2">my-system</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeNames--"><code>getAttributeNames</code></a>().length</code>
</td><td>2</td><td>1</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChildren--"><code>getChildren</code></a>().length</code>
</td><td colspan="2">2</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsFloat-java.lang.String-"><code>getAttributeAsFloat</code></a>("version")</code>
</td><td colspan="2">1.3</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("widget").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttribute-java.lang.String-"><code>getAttribute</code></a>("name")</code>
</td><td colspan="2">fooWidget</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("widget")
.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsBoolean-java.lang.String-"><code>getAttributeAsBoolean</code></a>("threadsafe")</code></td><td colspan="2">
<code>true</code></td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("widget").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getLocation--"><code>getLocation</code></a>()</code>
</td><td colspan="2">file:///home/jeff/tmp/java/avalon/src/java/new.xconf:4:60</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("desc").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getName--"><code>getName</code></a>()</code>
</td><td>desc (see <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild(String)</code></a>)</td><td>desc</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("doc:desc").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getName--"><code>getName</code></a>()</code>
</td><td>doc:desc</td><td>doc:desc (see <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild(String)</code></a>)</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("desc").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValue--"><code>getValue</code></a>()</code>
</td><td><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration"><code>ConfigurationException</code></a></td><td>This is a highly fictitious config file</td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("doc:desc").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValue--"><code>getValue</code></a>()</code>
</td><td>This is a highly fictitious config file</td><td><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration"><code>ConfigurationException</code></a></td></tr>
<tr align="center"><td align="left">
<code>conf.<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild</code></a>("desc").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getNamespace--"><code>getNamespace</code></a>()</code>
</td><td> </td><td>http://myco.com/documentation"</td></tr>
</table>
</p>
<p>
Type-safe utility methods are provided for retrieving attribute and element
values as <code>String</code>, <code>int</code>, <code>long</code>,
<code>float</code> and <code>boolean</code>.
</p>
<h3>Miscellanea</h3>
<p>
Currently, the configuration tree can only be traversed one node at a time,
eg., through <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-"><code>getChild("foo")</code></a> or <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChildren--"><code>getChildren()</code></a>. In
a future release, it may be possible to access child nodes with an XPath-like
syntax.
</p>
<p>
Checking for the existence of an attribute can be done as follows:
</p>
<pre>
String value = conf.getAttribute( "myAttribute", null );
if ( null == value )
{
// Do the processing applicable if the attribute isn't present.
}
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>CVS $Revision: 1.29 $ $Date: 2004/02/11 14:34:24 $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:dev@avalon.apache.org">Avalon Development Team</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String paramName)</code>
<div class="block">Return the value of specified attribute.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttribute-java.lang.String-java.lang.String-">getAttribute</a></span>(java.lang.String name,
java.lang.String defaultValue)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>String</code>, or the default value if no attribute by
that name exists or is empty.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsBoolean-java.lang.String-">getAttributeAsBoolean</a></span>(java.lang.String paramName)</code>
<div class="block">Return the <code>boolean</code> value of the specified parameter contained
in this node.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsBoolean-java.lang.String-boolean-">getAttributeAsBoolean</a></span>(java.lang.String name,
boolean defaultValue)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>boolean</code>, or the default value if no attribute by
that name exists or is empty.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsFloat-java.lang.String-">getAttributeAsFloat</a></span>(java.lang.String paramName)</code>
<div class="block">Return the <code>float</code> value of the specified parameter contained
in this node.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsFloat-java.lang.String-float-">getAttributeAsFloat</a></span>(java.lang.String name,
float defaultValue)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>float</code>, or the default value if no attribute by
that name exists or is empty.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsInteger-java.lang.String-">getAttributeAsInteger</a></span>(java.lang.String paramName)</code>
<div class="block">Return the <code>int</code> value of the specified attribute contained
in this node.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsInteger-java.lang.String-int-">getAttributeAsInteger</a></span>(java.lang.String name,
int defaultValue)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>int</code>, or the default value if no attribute by
that name exists or is empty.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsLong-java.lang.String-">getAttributeAsLong</a></span>(java.lang.String name)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>long</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeAsLong-java.lang.String-long-">getAttributeAsLong</a></span>(java.lang.String name,
long defaultValue)</code>
<div class="block">Returns the value of the attribute specified by its name as a
<code>long</code>, or the default value if no attribute by
that name exists or is empty.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getAttributeNames--">getAttributeNames</a></span>()</code>
<div class="block">Return an array of all attribute names.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-">getChild</a></span>(java.lang.String child)</code>
<div class="block">Return a new <code>Configuration</code> instance encapsulating the
specified child node.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-boolean-">getChild</a></span>(java.lang.String child,
boolean createNew)</code>
<div class="block">Return a <code>Configuration</code> instance encapsulating the specified
child node.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChildren--">getChildren</a></span>()</code>
<div class="block">Return an <code>Array</code> of <code>Configuration</code>
elements containing all node children.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChildren-java.lang.String-">getChildren</a></span>(java.lang.String name)</code>
<div class="block">Return an <code>Array</code> of <code>Configuration</code>
elements containing all node children with the specified name.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getLocation--">getLocation</a></span>()</code>
<div class="block">Return a string describing location of Configuration.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getName--">getName</a></span>()</code>
<div class="block">Return the name of the node.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getNamespace--">getNamespace</a></span>()</code>
<div class="block">Returns a string indicating which namespace this Configuration node
belongs to.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValue--">getValue</a></span>()</code>
<div class="block">Return the <code>String</code> value of the node.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValue-java.lang.String-">getValue</a></span>(java.lang.String defaultValue)</code>
<div class="block">Returns the value of the configuration element as a <code>String</code>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsBoolean--">getValueAsBoolean</a></span>()</code>
<div class="block">Return the <code>boolean</code> value of the node.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsBoolean-boolean-">getValueAsBoolean</a></span>(boolean defaultValue)</code>
<div class="block">Returns the value of the configuration element as a <code>boolean</code>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsFloat--">getValueAsFloat</a></span>()</code>
<div class="block">Return the <code>float</code> value of the node.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsFloat-float-">getValueAsFloat</a></span>(float defaultValue)</code>
<div class="block">Returns the value of the configuration element as a <code>float</code>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsInteger--">getValueAsInteger</a></span>()</code>
<div class="block">Return the <code>int</code> value of the node.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsInteger-int-">getValueAsInteger</a></span>(int defaultValue)</code>
<div class="block">Returns the value of the configuration element as an <code>int</code>.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsLong--">getValueAsLong</a></span>()</code>
<div class="block">Return the <code>long</code> value of the node.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValueAsLong-long-">getValueAsLong</a></span>(long defaultValue)</code>
<div class="block">Returns the value of the configuration element as a <code>long</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">Return the name of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of the <code>Configuration</code> node.</dd>
</dl>
</li>
</ul>
<a name="getLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocation</h4>
<pre>java.lang.String getLocation()</pre>
<div class="block">Return a string describing location of Configuration.
Location can be different for different mediums (ie "file:line" for normal XML files or
"table:primary-key" for DB based configurations);</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string describing location of Configuration</dd>
</dl>
</li>
</ul>
<a name="getNamespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre>java.lang.String getNamespace()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Returns a string indicating which namespace this Configuration node
belongs to.
<p>
What this returns is dependent on the configuration file and the
Configuration builder. If the Configuration builder does not support
namespaces, this method will return a blank string.
</p>
<p>In the case of <a href="../../../../../org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.html" title="class in org.apache.avalon.framework.configuration"><code>DefaultConfigurationBuilder</code></a>, the namespace will
be the URI associated with the XML element. Eg.,:</p>
<pre>
<foo xmlns:x="http://blah.com">
<x:bar/>
</foo>
</pre>
<p>The namespace of <code>foo</code> will be "", and the namespace of
<code>bar</code> will be "http://blah.com".</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String identifying the namespace of this Configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - if an error occurs</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a name="getChild-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChild</h4>
<pre><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a> getChild(java.lang.String child)</pre>
<div class="block">Return a new <code>Configuration</code> instance encapsulating the
specified child node.
<p>
If no such child node exists, an empty <code>Configuration</code> will be
returned, allowing constructs such as
<code>conf.getChild("foo").getChild("bar").getChild("baz").<a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getValue-java.lang.String-"><code>getValue</code></a>("default");</code>
</p>
<p>
If you wish to get a <code>null</code> return when no element is present,
use <a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html#getChild-java.lang.String-boolean-"><code>getChild("foo", <b>false</b>)</code></a>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>child</code> - The name of the child node.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Configuration</dd>
</dl>
</li>
</ul>
<a name="getChild-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChild</h4>
<pre><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a> getChild(java.lang.String child,
boolean createNew)</pre>
<div class="block">Return a <code>Configuration</code> instance encapsulating the specified
child node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>child</code> - The name of the child node.</dd>
<dd><code>createNew</code> - If <code>true</code>, a new <code>Configuration</code>
will be created and returned if the specified child does not exist. If
<code>false</code>, <code>null</code> will be returned when the specified
child doesn't exist.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Configuration</dd>
</dl>
</li>
</ul>
<a name="getChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a>[] getChildren()</pre>
<div class="block">Return an <code>Array</code> of <code>Configuration</code>
elements containing all node children. The array order will reflect the
order in the source config file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>All child nodes</dd>
</dl>
</li>
</ul>
<a name="getChildren-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre><a href="../../../../../org/apache/avalon/framework/configuration/Configuration.html" title="interface in org.apache.avalon.framework.configuration">Configuration</a>[] getChildren(java.lang.String name)</pre>
<div class="block">Return an <code>Array</code> of <code>Configuration</code>
elements containing all node children with the specified name. The array
order will reflect the order in the source config file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the children to get.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The child nodes with name <code>name</code></dd>
</dl>
</li>
</ul>
<a name="getAttributeNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNames</h4>
<pre>java.lang.String[] getAttributeNames()</pre>
<div class="block">Return an array of all attribute names.
<p>
<em>The order of attributes in this array can not be relied on.</em> As
with XML, a <code>Configuration</code>'s attributes are an
<em>unordered</em> set. If your code relies on order, eg
<tt>conf.getAttributeNames()[0]</tt>, then it is liable to break if a
different XML parser is used.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>String[]</code> value</dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.String getAttribute(java.lang.String paramName)
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the value of specified attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paramName</code> - The name of the parameter you ask the value of.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String value of attribute.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If no attribute with that name exists.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsInteger-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsInteger</h4>
<pre>int getAttributeAsInteger(java.lang.String paramName)
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>int</code> value of the specified attribute contained
in this node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paramName</code> - The name of the parameter you ask the value of.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int value of attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If no parameter with that name exists.
or if conversion to <code>int</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsLong-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsLong</h4>
<pre>long getAttributeAsLong(java.lang.String name)
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>long</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the parameter you ask the value of.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long value of attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If no parameter with that name exists.
or if conversion to <code>long</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsFloat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsFloat</h4>
<pre>float getAttributeAsFloat(java.lang.String paramName)
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>float</code> value of the specified parameter contained
in this node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paramName</code> - The name of the parameter you ask the value of.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>float value of attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If no parameter with that name exists.
or if conversion to <code>float</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsBoolean-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsBoolean</h4>
<pre>boolean getAttributeAsBoolean(java.lang.String paramName)
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>boolean</code> value of the specified parameter contained
in this node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paramName</code> - The name of the parameter you ask the value of.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean value of attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If no parameter with that name exists.
or if conversion to <code>boolean</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String getValue()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>String</code> value of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - if an error occurs</dd>
</dl>
</li>
</ul>
<a name="getValueAsInteger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsInteger</h4>
<pre>int getValueAsInteger()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>int</code> value of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If conversion to <code>int</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getValueAsFloat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsFloat</h4>
<pre>float getValueAsFloat()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>float</code> value of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If conversion to <code>float</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getValueAsBoolean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsBoolean</h4>
<pre>boolean getValueAsBoolean()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>boolean</code> value of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If conversion to <code>boolean</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getValueAsLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsLong</h4>
<pre>long getValueAsLong()
throws <a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></pre>
<div class="block">Return the <code>long</code> value of the node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration">ConfigurationException</a></code> - If conversion to <code>long</code> fails.</dd>
</dl>
</li>
</ul>
<a name="getValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String getValue(java.lang.String defaultValue)</pre>
<div class="block">Returns the value of the configuration element as a <code>String</code>.
If the configuration value is not set, the default value will be
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String value of the <code>Configuration</code>, or default
if none specified.</dd>
</dl>
</li>
</ul>
<a name="getValueAsInteger-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsInteger</h4>
<pre>int getValueAsInteger(int defaultValue)</pre>
<div class="block">Returns the value of the configuration element as an <code>int</code>.
If the configuration value is not set, the default value will be
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int value of the <code>Configuration</code>, or default
if none specified.</dd>
</dl>
</li>
</ul>
<a name="getValueAsLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsLong</h4>
<pre>long getValueAsLong(long defaultValue)</pre>
<div class="block">Returns the value of the configuration element as a <code>long</code>.
If the configuration value is not set, the default value will be
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long value of the <code>Configuration</code>, or default
if none specified.</dd>
</dl>
</li>
</ul>
<a name="getValueAsFloat-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsFloat</h4>
<pre>float getValueAsFloat(float defaultValue)</pre>
<div class="block">Returns the value of the configuration element as a <code>float</code>.
If the configuration value is not set, the default value will be
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>float value of the <code>Configuration</code>, or default
if none specified.</dd>
</dl>
</li>
</ul>
<a name="getValueAsBoolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAsBoolean</h4>
<pre>boolean getValueAsBoolean(boolean defaultValue)</pre>
<div class="block">Returns the value of the configuration element as a <code>boolean</code>.
If the configuration value is not set, the default value will be
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean value of the <code>Configuration</code>, or default
if none specified.</dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.String getAttribute(java.lang.String name,
java.lang.String defaultValue)</pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>String</code>, or the default value if no attribute by
that name exists or is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the attribute you ask the value of.</dd>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String value of attribute. It will return the default
value if the named attribute does not exist, or if
the value is not set.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsInteger-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsInteger</h4>
<pre>int getAttributeAsInteger(java.lang.String name,
int defaultValue)</pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>int</code>, or the default value if no attribute by
that name exists or is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the attribute you ask the value of.</dd>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int value of attribute. It will return the default
value if the named attribute does not exist, or if
the value is not set.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsLong-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsLong</h4>
<pre>long getAttributeAsLong(java.lang.String name,
long defaultValue)</pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>long</code>, or the default value if no attribute by
that name exists or is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the attribute you ask the value of.</dd>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long value of attribute. It will return the default
value if the named attribute does not exist, or if
the value is not set.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsFloat-java.lang.String-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAsFloat</h4>
<pre>float getAttributeAsFloat(java.lang.String name,
float defaultValue)</pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>float</code>, or the default value if no attribute by
that name exists or is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the attribute you ask the value of.</dd>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>float value of attribute. It will return the default
value if the named attribute does not exist, or if
the value is not set.</dd>
</dl>
</li>
</ul>
<a name="getAttributeAsBoolean-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAttributeAsBoolean</h4>
<pre>boolean getAttributeAsBoolean(java.lang.String name,
boolean defaultValue)</pre>
<div class="block">Returns the value of the attribute specified by its name as a
<code>boolean</code>, or the default value if no attribute by
that name exists or is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the attribute you ask the value of.</dd>
<dd><code>defaultValue</code> - The default value desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean value of attribute. It will return the default
value if the named attribute does not exist, or if
the value is not set.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/avalon/framework/configuration/Configurable.html" title="interface in org.apache.avalon.framework.configuration"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/avalon/framework/configuration/ConfigurationException.html" title="class in org.apache.avalon.framework.configuration"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/avalon/framework/configuration/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|