Plan/all/com/djrapitops/plan/gathering/SystemUsage.html

288 lines
9.9 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>SystemUsage (Plan 5.1-SNAPSHOT API)</title>
2020-01-24 11:56:15 +01:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
2019-08-05 11:13:19 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-03-21 15:43:05 +01:00
parent.document.title="SystemUsage (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2020-01-24 11:56:15 +01:00
var methods = {"i0":9,"i1":9,"i2":9};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../overview-summary.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2020-01-24 11:56:15 +01:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../com/djrapitops/plan/gathering/SpongeSensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/gathering/VelocitySensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../index.html?com/djrapitops/plan/gathering/SystemUsage.html" target="_top">Frames</a></li>
<li><a href="SystemUsage.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">
2020-01-24 11:56:15 +01:00
<div class="subTitle">com.djrapitops.plan.gathering</div>
<h2 title="Class SystemUsage" class="title">Class SystemUsage</h2>
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2020-01-24 11:56:15 +01:00
<li>com.djrapitops.plan.gathering.SystemUsage</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
2020-01-24 11:56:15 +01:00
<pre>public class <span class="typeNameLabel">SystemUsage</span>
2019-08-05 11:13:19 +02:00
extends java.lang.Object</pre>
2020-01-24 11:56:15 +01:00
<div class="block">Utility class for obtaining System usage statistics.</div>
2019-08-05 11:13:19 +02:00
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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">
2020-01-24 11:56:15 +01:00
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/SystemUsage.html#getAverageSystemLoad--">getAverageSystemLoad</a></span>()</code>
<div class="block">Check how active the system is (CPU) or if not available, using system load average.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/SystemUsage.html#getFreeDiskSpace--">getFreeDiskSpace</a></span>()</code>
<div class="block">Check how much disk space is available on the current partition.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/SystemUsage.html#getUsedMemory--">getUsedMemory</a></span>()</code>
<div class="block">Check how much memory (in Mb) is in use.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
2020-01-24 11:56:15 +01:00
<a name="getUsedMemory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsedMemory</h4>
<pre>public static&nbsp;long&nbsp;getUsedMemory()</pre>
<div class="block">Check how much memory (in Mb) is in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>used memory (megabytes) at the time of fetching</dd>
</dl>
</li>
</ul>
<a name="getAverageSystemLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageSystemLoad</h4>
<pre>public static&nbsp;double&nbsp;getAverageSystemLoad()</pre>
<div class="block">Check how active the system is (CPU) or if not available, using system load average.
<p>
- On some OSes CPU usage information is not available, and system load average is used instead.
- On some OSes system load average is not available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0.0 to 100.0 if CPU, or system load average, or -1 if nothing is available.</dd>
</dl>
</li>
</ul>
<a name="getFreeDiskSpace--">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-01-24 11:56:15 +01:00
<h4>getFreeDiskSpace</h4>
<pre>public static&nbsp;long&nbsp;getFreeDiskSpace()</pre>
<div class="block">Check how much disk space is available on the current partition.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>free disk space (megabytes) on the partition JVM working directory is in.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - if permission is required to see disk space.</dd>
</dl>
2019-08-05 11:13:19 +02:00
</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">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../overview-summary.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2020-01-24 11:56:15 +01:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../com/djrapitops/plan/gathering/SpongeSensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/gathering/VelocitySensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../index.html?com/djrapitops/plan/gathering/SystemUsage.html" target="_top">Frames</a></li>
<li><a href="SystemUsage.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
2020-01-24 11:56:15 +01:00
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>