fixed some formatting typos
[vimdoclet.git] / sample / java.lang.management.OperatingSystemMXBean.txt
blob3290fafebabfb652859e1268f2b80b1e42488d74
1 *java.lang.management.OperatingSystemMXBean* *OperatingSystemMXBean* The managem
3 public interface interface OperatingSystemMXBean
6 |java.lang.management.OperatingSystemMXBean_Description|
7 |java.lang.management.OperatingSystemMXBean_Fields|
8 |java.lang.management.OperatingSystemMXBean_Constructors|
9 |java.lang.management.OperatingSystemMXBean_Methods|
11 ================================================================================
13 *java.lang.management.OperatingSystemMXBean_Methods*
14 |java.lang.management.OperatingSystemMXBean.getArch()|Returns the operating sys
15 |java.lang.management.OperatingSystemMXBean.getAvailableProcessors()|Returns th
16 |java.lang.management.OperatingSystemMXBean.getName()|Returns the operating sys
17 |java.lang.management.OperatingSystemMXBean.getSystemLoadAverage()|Returns the 
18 |java.lang.management.OperatingSystemMXBean.getVersion()|Returns the operating 
20 *java.lang.management.OperatingSystemMXBean_Description*
22 The management interface for the operating system on which the Java virtual 
23 machine is running. 
25 A Java virtual machine has a single instance of the implementation class of 
26 this interface. This instance implementing this interface is an MXBean that can 
27 be obtained by calling the (|java.lang.management.ManagementFactory|) method or 
28 from the platform 
29 <tt>MBeanServer</tt>(|java.lang.management.ManagementFactory|) method. 
31 The ObjectName for uniquely identifying the MXBean for the operating system 
32 within an MBeanServer is: 
33 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
36 This interface defines several convenient methods for accessing system 
37 properties about the operating system on which the Java virtual machine is 
38 running. 
42 *java.lang.management.OperatingSystemMXBean.getArch()*
44 public |java.lang.String| getArch()
46 Returns the operating system architecture. This method is equivalent to 
47 System.getProperty("os.arch"). 
51     Returns: the operating system architecture. 
53 *java.lang.management.OperatingSystemMXBean.getAvailableProcessors()*
55 public int getAvailableProcessors()
57 Returns the number of processors available to the Java virtual machine. This 
58 method is equivalent to the (|java.lang.Runtime|) method. This value may change 
59 during a particular invocation of the virtual machine. 
63     Returns: the number of processors available to the virtual machine; never smaller than 
64              one. 
66 *java.lang.management.OperatingSystemMXBean.getName()*
68 public |java.lang.String| getName()
70 Returns the operating system name. This method is equivalent to 
71 System.getProperty("os.name"). 
75     Returns: the operating system name. 
77 *java.lang.management.OperatingSystemMXBean.getSystemLoadAverage()*
79 public double getSystemLoadAverage()
81 Returns the system load average for the last minute. The system load average is 
82 the sum of the number of runnable entities queued to the available 
83 processors(|java.lang.management.OperatingSystemMXBean|) and the number of 
84 runnable entities running on the available processors averaged over a period of 
85 time. The way in which the load average is calculated is operating system 
86 specific but is typically a damped time-dependent average. 
88 If the load average is not available, a negative value is returned. 
90 This method is designed to provide a hint about the system load and may be 
91 queried frequently. The load average may be unavailable on some platform where 
92 it is expensive to implement this method. 
96     Returns: the system load average; or a negative value if not available. 
98 *java.lang.management.OperatingSystemMXBean.getVersion()*
100 public |java.lang.String| getVersion()
102 Returns the operating system version. This method is equivalent to 
103 System.getProperty("os.version"). 
107     Returns: the operating system version.