/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/monitor/StatusVariable.html is in libosgi-compendium-java-doc 5.0.0-5.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>StatusVariable</title>
<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="StatusVariable";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/osgi/service/monitor/MonitorPermission.html" title="class in org.osgi.service.monitor"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/monitor/StatusVariable.html" target="_top">Frames</a></li>
<li><a href="StatusVariable.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.osgi.service.monitor</div>
<h2 title="Class StatusVariable" class="title">Class StatusVariable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.monitor.StatusVariable</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">StatusVariable</span>
extends java.lang.Object</pre>
<div class="block">A <code>StatusVariable</code> object represents the value of a status variable
taken with a certain collection method at a certain point of time. The type
of the <code>StatusVariable</code> can be <code>int</code>, <code>float</code>,
<code>boolean</code> or <code>String</code>.
<p>
A <code>StatusVariable</code> is identified by an ID string that is unique within
the scope of a <code>Monitorable</code>. The ID must be a non- <code>null</code>,
non-empty string that conforms to the "symbolic-name" definition in the OSGi
core specification. This means that only the characters [-_.a-zA-Z0-9] may be
used. The length of the ID must not exceed 32 bytes when UTF-8 encoded.</div>
</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="memberSummary" 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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#CM_CC">CM_CC</a></span></code>
<div class="block">Constant for identifying 'Cumulative Counter' data collection method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#CM_DER">CM_DER</a></span></code>
<div class="block">Constant for identifying 'Discrete Event Registration' data collection
method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#CM_GAUGE">CM_GAUGE</a></span></code>
<div class="block">Constant for identifying 'Gauge' data collection method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#CM_SI">CM_SI</a></span></code>
<div class="block">Constant for identifying 'Status Inspection' data collection method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#TYPE_BOOLEAN">TYPE_BOOLEAN</a></span></code>
<div class="block">Constant for identifying <code>boolean</code> data type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#TYPE_FLOAT">TYPE_FLOAT</a></span></code>
<div class="block">Constant for identifying <code>float</code> data type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#TYPE_INTEGER">TYPE_INTEGER</a></span></code>
<div class="block">Constant for identifying <code>int</code> data type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#TYPE_STRING">TYPE_STRING</a></span></code>
<div class="block">Constant for identifying <code>String</code> data type.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#StatusVariable-java.lang.String-int-boolean-">StatusVariable</a></span>(java.lang.String id,
int cm,
boolean data)</code>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>boolean</code> type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#StatusVariable-java.lang.String-int-float-">StatusVariable</a></span>(java.lang.String id,
int cm,
float data)</code>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>float</code> type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#StatusVariable-java.lang.String-int-int-">StatusVariable</a></span>(java.lang.String id,
int cm,
int data)</code>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>int</code> type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#StatusVariable-java.lang.String-int-java.lang.String-">StatusVariable</a></span>(java.lang.String id,
int cm,
java.lang.String data)</code>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>String</code> type.</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="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code>
<div class="block">Compares the specified object with this <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getBoolean--">getBoolean</a></span>()</code>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>boolean</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getCollectionMethod--">getCollectionMethod</a></span>()</code>
<div class="block">Returns the collection method of this <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getFloat--">getFloat</a></span>()</code>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>float</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getID--">getID</a></span>()</code>
<div class="block">Returns the ID of this <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getInteger--">getInteger</a></span>()</code>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>int</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getString--">getString</a></span>()</code>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>String</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getTimeStamp--">getTimeStamp</a></span>()</code>
<div class="block">Returns the timestamp associated with the <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#getType--">getType</a></span>()</code>
<div class="block">Returns information on the data type of this <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/StatusVariable.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Returns the hash code value for this <code>StatusVariable</code>.</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/osgi/service/monitor/StatusVariable.html#toString--">toString</a></span>()</code>
<div class="block">Returns a <code>String</code> representation of this <code>StatusVariable</code>.</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.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="TYPE_INTEGER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_INTEGER</h4>
<pre>public static final int TYPE_INTEGER</pre>
<div class="block">Constant for identifying <code>int</code> data type.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.TYPE_INTEGER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE_FLOAT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_FLOAT</h4>
<pre>public static final int TYPE_FLOAT</pre>
<div class="block">Constant for identifying <code>float</code> data type.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.TYPE_FLOAT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_STRING</h4>
<pre>public static final int TYPE_STRING</pre>
<div class="block">Constant for identifying <code>String</code> data type.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.TYPE_STRING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE_BOOLEAN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_BOOLEAN</h4>
<pre>public static final int TYPE_BOOLEAN</pre>
<div class="block">Constant for identifying <code>boolean</code> data type.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.TYPE_BOOLEAN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_CC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CM_CC</h4>
<pre>public static final int CM_CC</pre>
<div class="block">Constant for identifying 'Cumulative Counter' data collection method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.CM_CC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_DER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CM_DER</h4>
<pre>public static final int CM_DER</pre>
<div class="block">Constant for identifying 'Discrete Event Registration' data collection
method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.CM_DER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_GAUGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CM_GAUGE</h4>
<pre>public static final int CM_GAUGE</pre>
<div class="block">Constant for identifying 'Gauge' data collection method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.CM_GAUGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_SI">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CM_SI</h4>
<pre>public static final int CM_SI</pre>
<div class="block">Constant for identifying 'Status Inspection' data collection method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.monitor.StatusVariable.CM_SI">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="StatusVariable-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StatusVariable</h4>
<pre>public StatusVariable(java.lang.String id,
int cm,
int data)</pre>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>int</code> type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code></dd>
<dd><code>cm</code> - the collection method, one of the <code>CM_</code> constants</dd>
<dd><code>data</code> - the <code>int</code> value of the <code>StatusVariable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>id</code> is not
a valid <code>StatusVariable</code> name, or if <code>cm</code> is not one
of the collection method constants</dd>
<dd><code>java.lang.NullPointerException</code> - if the <code>id</code> parameter is
<code>null</code></dd>
</dl>
</li>
</ul>
<a name="StatusVariable-java.lang.String-int-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StatusVariable</h4>
<pre>public StatusVariable(java.lang.String id,
int cm,
float data)</pre>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>float</code> type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code></dd>
<dd><code>cm</code> - the collection method, one of the <code>CM_</code> constants</dd>
<dd><code>data</code> - the <code>float</code> value of the <code>StatusVariable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>id</code> is not
a valid <code>StatusVariable</code> name, or if <code>cm</code> is not one
of the collection method constants</dd>
<dd><code>java.lang.NullPointerException</code> - if the <code>id</code> parameter is
<code>null</code></dd>
</dl>
</li>
</ul>
<a name="StatusVariable-java.lang.String-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StatusVariable</h4>
<pre>public StatusVariable(java.lang.String id,
int cm,
boolean data)</pre>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>boolean</code> type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code></dd>
<dd><code>cm</code> - the collection method, one of the <code>CM_</code> constants</dd>
<dd><code>data</code> - the <code>boolean</code> value of the <code>StatusVariable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>id</code> is not
a valid <code>StatusVariable</code> name, or if <code>cm</code> is not one
of the collection method constants</dd>
<dd><code>java.lang.NullPointerException</code> - if the <code>id</code> parameter is
<code>null</code></dd>
</dl>
</li>
</ul>
<a name="StatusVariable-java.lang.String-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StatusVariable</h4>
<pre>public StatusVariable(java.lang.String id,
int cm,
java.lang.String data)</pre>
<div class="block">Constructor for a <code>StatusVariable</code> of <code>String</code> type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code></dd>
<dd><code>cm</code> - the collection method, one of the <code>CM_</code> constants</dd>
<dd><code>data</code> - the <code>String</code> value of the <code>StatusVariable</code>, can
be <code>null</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>id</code> is not
a valid <code>StatusVariable</code> name, or if <code>cm</code> is not one
of the collection method constants</dd>
<dd><code>java.lang.NullPointerException</code> - if the <code>id</code> parameter is
<code>null</code></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="getID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre>public java.lang.String getID()</pre>
<div class="block">Returns the ID of this <code>StatusVariable</code>. The ID is unique within
the scope of a <code>Monitorable</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID of this <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public int getType()</pre>
<div class="block">Returns information on the data type of this <code>StatusVariable</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>one of the <code>TYPE_</code> constants indicating the type of this
<code>StatusVariable</code></dd>
</dl>
</li>
</ul>
<a name="getTimeStamp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeStamp</h4>
<pre>public java.util.Date getTimeStamp()</pre>
<div class="block">Returns the timestamp associated with the <code>StatusVariable</code>. The
timestamp is stored when the <code>StatusVariable</code> instance is created,
generally during the <a href="../../../../org/osgi/service/monitor/Monitorable.html#getStatusVariable-java.lang.String-"><code>Monitorable.getStatusVariable(String)</code></a> method
call.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time when the <code>StatusVariable</code> value was queried,
cannot be <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public java.lang.String getString()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>String</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> value as a <code>String</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the type of the
<code>StatusVariable</code> is not <code>String</code></dd>
</dl>
</li>
</ul>
<a name="getInteger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteger</h4>
<pre>public int getInteger()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>int</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> value as an <code>int</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the type of this
<code>StatusVariable</code> is not <code>int</code></dd>
</dl>
</li>
</ul>
<a name="getFloat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloat</h4>
<pre>public float getFloat()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>float</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> value as a <code>float</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the type of this
<code>StatusVariable</code> is not <code>float</code></dd>
</dl>
</li>
</ul>
<a name="getBoolean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoolean</h4>
<pre>public boolean getBoolean()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the <code>StatusVariable</code> value if its type is <code>boolean</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> value as a <code>boolean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the type of this
<code>StatusVariable</code> is not <code>boolean</code></dd>
</dl>
</li>
</ul>
<a name="getCollectionMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollectionMethod</h4>
<pre>public int getCollectionMethod()</pre>
<div class="block">Returns the collection method of this <code>StatusVariable</code>. See section
3.3 b) in [ETSI TS 132 403]</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>one of the <code>CM_</code> constants</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<div class="block">Compares the specified object with this <code>StatusVariable</code>. Two
<code>StatusVariable</code> objects are considered equal if their full path,
collection method and type are identical, and the data (selected by their
type) is equal.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the object to compare with this <code>StatusVariable</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the argument represents the same
<code>StatusVariable</code> as this object</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Returns the hash code value for this <code>StatusVariable</code>. The hash
code is calculated based on the full path, collection method and value of
the <code>StatusVariable</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code of this object</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a <code>String</code> representation of this <code>StatusVariable</code>.
The returned <code>String</code> contains the full path, collection method,
timestamp, type and value parameters of the <code>StatusVariable</code> in the
following format:
<pre>
StatusVariable(<path>, <cm>, <timestamp>, <type>, <value>)
</pre>
The collection method identifiers used in the string representation are
"CC", "DER", "GAUGE" and "SI" (without the quotes). The format of the
timestamp is defined by the <code>Date.toString</code> method, while the type
is identified by one of the strings "INTEGER", "FLOAT", "STRING" and
"BOOLEAN". The final field contains the string representation of the
value of the status variable.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>String</code> representation of this <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<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/osgi/service/monitor/MonitorPermission.html" title="class in org.osgi.service.monitor"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/monitor/StatusVariable.html" target="_top">Frames</a></li>
<li><a href="StatusVariable.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 ======= -->
</body>
</html>
|