/usr/share/doc/libpirl-java/api/PIRL/Viewers/Memory_History.html is in libpirl-java-doc 2.3.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Tue Nov 20 23:14:21 UTC 2012 -->
<title>Memory_History</title>
<meta name="date" content="2012-11-20">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Memory_History";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/Viewers/Memory_ChartUI.html" title="class in PIRL.Viewers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Viewers/Memory_Panel.html" title="class in PIRL.Viewers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Viewers/Memory_History.html" target="_top">Frames</a></li>
<li><a href="Memory_History.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">PIRL.Viewers</div>
<h2 title="Class Memory_History" class="title">Class Memory_History</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>PIRL.Viewers.Memory_History</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Memory_History</span>
extends <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A <i>Memory_History</i> provides a history of Java Runtime Environment
(JRE) memory use.
<p>
The JRE reports three categories of memory: the total amount of
<a href="../../PIRL/Viewers/Memory_History.html#Available_Memory()"><code>available memory</code></a> in the JRE heap space,
the amount of <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated memory</code></a> used by
objects, and the amount of <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free memory</code></a> that is
no longer in use by objects which can be garbage collected.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long[]</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Allocated">Allocated</a></strong></code>
<div class="block">The <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated memory</code></a> sampling history.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#DEFAULT_MAX_SAMPLES">DEFAULT_MAX_SAMPLES</a></strong></code>
<div class="block">The</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long[]</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Free">Free</a></strong></code>
<div class="block">The <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free memory</code></a> sampling history.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#ID">ID</a></strong></code>
<div class="block">Class identification name with source code version and date.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Samples">Samples</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Memory_History()">Memory_History</a></strong>()</code>
<div class="block">Constructs an idle Memory_History with <a href="../../PIRL/Viewers/Memory_History.html#DEFAULT_MAX_SAMPLES"><code>DEFAULT_MAX_SAMPLES</code></a>
sample capacity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Memory_History(int, int)">Memory_History</a></strong>(int max_samples,
int rate)</code>
<div class="block">Constructs at Memory_History with specified max samples and
sampling rate.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#addChangeListener(javax.swing.event.ChangeListener)">addChangeListener</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/javax/swing/event/ChangeListener.html?is-external=true" title="class or interface in javax.swing.event">ChangeListener</a> listener)</code>
<div class="block">Register a ChangeListener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long[]</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Allocated_History()">Allocated_History</a></strong>()</code>
<div class="block">Get allocated memory samples history.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()">Allocated_Memory</a></strong>()</code>
<div class="block">Get the amount of memory currently in use by the Java runtime
environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Available_Memory()">Available_Memory</a></strong>()</code>
<div class="block">Get the total amount of memory available to the Java runtime
environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Clear()">Clear</a></strong>()</code>
<div class="block">Clear the memory history.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#fireChange()">fireChange</a></strong>()</code>
<div class="block">Send a ChangeEvent referencing this Memory_History to each
registered ChangeListener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long[]</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Free_History()">Free_History</a></strong>()</code>
<div class="block">Get free memory samples history.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()">Free_Memory</a></strong>()</code>
<div class="block">Get the amount of memory allocated by the Java runtime environment
but not currently in use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Historical(long, long)">Historical</a></strong>(long free,
long allocated)</code>
<div class="block">Add values to the memory history.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long[][]</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#History()">History</a></strong>()</code>
<div class="block">Get the memory samples history.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Max_Samples()">Max_Samples</a></strong>()</code>
<div class="block">Get the maximum number of history samples that can be recorded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Max_Samples(int)">Max_Samples</a></strong>(int max_samples)</code>
<div class="block">Set the maximum number of history samples that can be recorded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Previous_Rate()">Previous_Rate</a></strong>()</code>
<div class="block">Get the previous sampling rate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Rate()">Rate</a></strong>()</code>
<div class="block">Get the rate at which memory usage is being sampled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Rate(int)">Rate</a></strong>(int rate)</code>
<div class="block">Set the rate at which to sample memory usage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#removeChangeListener(javax.swing.event.ChangeListener)">removeChangeListener</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/javax/swing/event/ChangeListener.html?is-external=true" title="class or interface in javax.swing.event">ChangeListener</a> listener)</code>
<div class="block">Remove a registered ChangeListener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Reset()">Reset</a></strong>()</code>
<div class="block">The memory history is emptied.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Viewers/Memory_History.html#Samples()">Samples</a></strong>()</code>
<div class="block">Get the count of valid memory history samples.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ID</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ID</pre>
<div class="block">Class identification name with source code version and date.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Viewers.Memory_History.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_MAX_SAMPLES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_SAMPLES</h4>
<pre>public static final int DEFAULT_MAX_SAMPLES</pre>
<div class="block">The</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Viewers.Memory_History.DEFAULT_MAX_SAMPLES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="Samples">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Samples</h4>
<pre>protected int Samples</pre>
</li>
</ul>
<a name="Free">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Free</h4>
<pre>protected long[] Free</pre>
<div class="block">The <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free memory</code></a> sampling history.</div>
</li>
</ul>
<a name="Allocated">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Allocated</h4>
<pre>protected long[] Allocated</pre>
<div class="block">The <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated memory</code></a> sampling history.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Memory_History(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Memory_History</h4>
<pre>public Memory_History(int max_samples,
int rate)</pre>
<div class="block">Constructs at Memory_History with specified max samples and
sampling rate.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>max_samples</code> - The maximum number of JRE memory use samples
to acquire.</dd><dd><code>rate</code> - The rate, in seconds, between memory samples.</dd></dl>
</li>
</ul>
<a name="Memory_History()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Memory_History</h4>
<pre>public Memory_History()</pre>
<div class="block">Constructs an idle Memory_History with <a href="../../PIRL/Viewers/Memory_History.html#DEFAULT_MAX_SAMPLES"><code>DEFAULT_MAX_SAMPLES</code></a>
sample capacity.
<p>
The Memory_History will have no history capacity and a memory
sampling will be disabled.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Free_Memory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Free_Memory</h4>
<pre>public static long Free_Memory()</pre>
<div class="block">Get the amount of memory allocated by the Java runtime environment
but not currently in use.
<p>
Free memory is part of the <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated</code></a> memory
pool but is not currently in use. Garbage collection frees memory.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The amount, in bytes, of allocated but free memory.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Runtime.html?is-external=true#freeMemory()" title="class or interface in java.lang"><code>Runtime.freeMemory()</code></a></dd></dl>
</li>
</ul>
<a name="Allocated_Memory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Allocated_Memory</h4>
<pre>public static long Allocated_Memory()</pre>
<div class="block">Get the amount of memory currently in use by the Java runtime
environment.
<p>
Allocated memory is taken from the total amount of memory made
available to the Java runtime environment when the Java virtual
machine is started. Memory that is allocated, but not <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free</code></a> is currently in use by the virtual machine,
including any user objects it is managing.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The amount, in bytes, of allocated memory.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Available_Memory()"><code>Available_Memory()</code></a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Runtime.html?is-external=true#totalMemory()" title="class or interface in java.lang"><code>Runtime.totalMemory()</code></a></dd></dl>
</li>
</ul>
<a name="Available_Memory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Available_Memory</h4>
<pre>public static long Available_Memory()</pre>
<div class="block">Get the total amount of memory available to the Java runtime
environment.
<p>
When the Java virtual machine is started some amount of the host
system memory is reserved for use by the Java runtime environment.
<a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated</code></a> memory is taken from available
memory when needed. The default amount of available memory can be
changed using the java -Xmx command line option.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The total amount of memory, in bytes, available to the Java
runtime environment.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Runtime.html?is-external=true#maxMemory()" title="class or interface in java.lang"><code>Runtime.maxMemory()</code></a></dd></dl>
</li>
</ul>
<a name="Rate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Rate</h4>
<pre>public int Rate()</pre>
<div class="block">Get the rate at which memory usage is being sampled.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The sampling rate in seconds. This will be zero if sampling
is not active.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Rate(int)"><code>Rate(int)</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Previous_Rate()"><code>Previous_Rate()</code></a></dd></dl>
</li>
</ul>
<a name="Rate(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Rate</h4>
<pre>public int Rate(int rate)</pre>
<div class="block">Set the rate at which to sample memory usage.
<p>
If the current sampling rate is the same as the new sampling
rate, nothing is done.
<p>
If the new sampling rate is less than or equal to zero the
sampling timer is stopped.
<p>
If the new sampling rate is positive a samping timer will be
constructed if one has not already been provided; otherwise the
current sampling history will be <a href="../../PIRL/Viewers/Memory_History.html#Clear()"><code>cleared</code></a>. If the
sampling timer is not already running it will be started. The
sampling timer's action event will <a href="../../PIRL/Viewers/Memory_History.html#Update()"><code>updated</code></a> the
memory history at the specified rate, and will continue to be updated
at the same rate until sampling is discontinued by setting the rate
at or below zero. The sampling rate may be changed while sampling is
active.
<p>
The intention is to have a sample at each rate point in time.
However, the timer can not guarantee this: Other activity on the
system may prevent the timer from generating an event at the
requested time. Nevertheless, by preventing events from being
coalesced there will still be the correct number of events generated
for the overall amount of elapsed time even though the burst of
catch-up events will result in memory values not being sampled at the
expected time; no sampling events will be dropped.
<p>
After the sampling rate has been changed a ChangeEvent is <a href="../../PIRL/Viewers/Memory_History.html#fireChange()"><code>fired</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rate</code> - The rate, in seconds, between each memory usage sample.
If less than or equal to zero sampling will be discontinued.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The previous sampling rate. If this value is not zero the
<a href="../../PIRL/Viewers/Memory_History.html#Previous_Rate()"><code>previous rate</code></a> will be recorded.</dd></dl>
</li>
</ul>
<a name="Previous_Rate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Previous_Rate</h4>
<pre>public int Previous_Rate()</pre>
<div class="block">Get the previous sampling rate.
<p>
The value returned is the previous non-zero sampling rate that was
used. However, if sampling was never enabled then this will be zero.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The previous non-zero sampling rate, or zero if sampling was
never enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Rate()"><code>Rate()</code></a></dd></dl>
</li>
</ul>
<a name="Historical(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Historical</h4>
<pre>protected void Historical(long free,
long allocated)</pre>
<div class="block">Add values to the memory history.
<p>
If the history <a href="../../PIRL/Viewers/Memory_History.html#Max_Samples()"><code>capacity</code></a> has not been reached
the valid <a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>samples count</code></a> is incremented. All the
current allocated and free memory sample values are shifted down in
their arrays and then the new values are set as the current (index
zero) entries.
<p>
It might be argued that new sample values should be added to the end
of the history arrays rather than at the beginning. However, once the
history capacity has been reached the array contents would need to be
shifted anyway. It is conceptually and programatically easier to work
with the history arrays if the most recent sample is first.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>free</code> - The new free memory sample value.</dd><dd><code>allocated</code> - The new allocated memory sample value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Allocated_History()"><code>Allocated_History()</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Free_History()"><code>Free_History()</code></a></dd></dl>
</li>
</ul>
<a name="Samples()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Samples</h4>
<pre>public int Samples()</pre>
<div class="block">Get the count of valid memory history samples.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of valid memory history samples that are available.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Allocated_History()"><code>Allocated_History()</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Free_History()"><code>Free_History()</code></a></dd></dl>
</li>
</ul>
<a name="Max_Samples()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Samples</h4>
<pre>public int Max_Samples()</pre>
<div class="block">Get the maximum number of history samples that can be recorded.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The maximum number of history samples that will be recorded.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Allocated_History()"><code>Allocated_History()</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Free_History()"><code>Free_History()</code></a></dd></dl>
</li>
</ul>
<a name="Max_Samples(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Samples</h4>
<pre>public void Max_Samples(int max_samples)</pre>
<div class="block">Set the maximum number of history samples that can be recorded.
<p>
If the new sample capacity is different from the current sample
capacity new sample history arrays are allocated and the previous
valid sample values, up to the current <a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>sample count</code></a>
or the new capacity (whichever is smaller), are copied into the
new history arrays. Then the new history arrays are set as the
current history arrays.
<p>
After the history arrays have been changed a ChangeEvent is <a href="../../PIRL/Viewers/Memory_History.html#fireChange()"><code>fired</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>max_samples</code> - The memory history sample capacity. If the value
is less than or equal to zero the <a href="../../PIRL/Viewers/Memory_History.html#DEFAULT_MAX_SAMPLES"><code>DEFAULT_MAX_SAMPLES</code></a>
will be used.</dd></dl>
</li>
</ul>
<a name="Reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reset</h4>
<pre>public void Reset()</pre>
<div class="block">The memory history is emptied.
<p>
After the memory history has been reset a ChangeEvent is <a href="../../PIRL/Viewers/Memory_History.html#fireChange()"><code>fired</code></a>.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Clear()"><code>Clear()</code></a></dd></dl>
</li>
</ul>
<a name="Clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Clear</h4>
<pre>protected void Clear()</pre>
<div class="block">Clear the memory history.
<p>
The memory sample history array values and the count of valid
samples are set to zero.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>Samples()</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Allocated_History()"><code>Allocated_History()</code></a>,
<a href="../../PIRL/Viewers/Memory_History.html#Free_History()"><code>Free_History()</code></a></dd></dl>
</li>
</ul>
<a name="Free_History()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Free_History</h4>
<pre>public long[] Free_History()</pre>
<div class="block">Get free memory samples history.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of long values that contain the <a href="../../PIRL/Viewers/Memory_History.html#Historical(long, long)"><code>history</code></a> of <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free memory</code></a> samples. This array will have as many entries as
the <a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>samples count</code></a>.</dd></dl>
</li>
</ul>
<a name="Allocated_History()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Allocated_History</h4>
<pre>public long[] Allocated_History()</pre>
<div class="block">Get allocated memory samples history.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of long values that contain the <a href="../../PIRL/Viewers/Memory_History.html#Historical(long, long)"><code>history</code></a> of <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated memory</code></a> samples. This array will have as many entries as
the <a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>samples count</code></a>.</dd></dl>
</li>
</ul>
<a name="History()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>History</h4>
<pre>public long[][] History()</pre>
<div class="block">Get the memory samples history.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of long value pairs that contain the <a href="../../PIRL/Viewers/Memory_History.html#Historical(long, long)"><code>history</code></a> of <a href="../../PIRL/Viewers/Memory_History.html#Allocated_Memory()"><code>allocated memory</code></a> samples in the first value of the pair
(array[i][0] and <a href="../../PIRL/Viewers/Memory_History.html#Free_Memory()"><code>free memory</code></a> samples in
the second value of the pair (array[i][1]). This array will have
as many sample value pair entries as the <a href="../../PIRL/Viewers/Memory_History.html#Samples()"><code>samples count</code></a>.</dd></dl>
</li>
</ul>
<a name="addChangeListener(javax.swing.event.ChangeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addChangeListener</h4>
<pre>public void addChangeListener(<a href="/usr/share/doc/default-jdk-doc/api/javax/swing/event/ChangeListener.html?is-external=true" title="class or interface in javax.swing.event">ChangeListener</a> listener)</pre>
<div class="block">Register a ChangeListener.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The ChangeListener to be added to the list
registered for this Memory_History. The listener is not
added if it is already registered..</dd></dl>
</li>
</ul>
<a name="removeChangeListener(javax.swing.event.ChangeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeChangeListener</h4>
<pre>public boolean removeChangeListener(<a href="/usr/share/doc/default-jdk-doc/api/javax/swing/event/ChangeListener.html?is-external=true" title="class or interface in javax.swing.event">ChangeListener</a> listener)</pre>
<div class="block">Remove a registered ChangeListener.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The ChangeListener to be removed.</dd></dl>
</li>
</ul>
<a name="fireChange()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fireChange</h4>
<pre>protected void fireChange()</pre>
<div class="block">Send a ChangeEvent referencing this Memory_History to each
registered ChangeListener.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Viewers/Memory_History.html#addChangeListener(javax.swing.event.ChangeListener)"><code>addChangeListener(ChangeListener)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/Viewers/Memory_ChartUI.html" title="class in PIRL.Viewers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Viewers/Memory_Panel.html" title="class in PIRL.Viewers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Viewers/Memory_History.html" target="_top">Frames</a></li>
<li><a href="Memory_History.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>
|