sample/java.lang.management.RuntimeMXBean.txt

   1 *java.lang.management.RuntimeMXBean* *RuntimeMXBean* The management interface fo
   2
   3 public interface interface RuntimeMXBean
   4
   5
   6 |java.lang.management.RuntimeMXBean_Description|
   7 |java.lang.management.RuntimeMXBean_Fields|
   8 |java.lang.management.RuntimeMXBean_Constructors|
   9 |java.lang.management.RuntimeMXBean_Methods|
  10
  11 ================================================================================
  12
  13 *java.lang.management.RuntimeMXBean_Methods*
  14 |java.lang.management.RuntimeMXBean.getBootClassPath()|Returns the boot class p
  15 |java.lang.management.RuntimeMXBean.getClassPath()|Returns the Java class path
  16 |java.lang.management.RuntimeMXBean.getInputArguments()|Returns the input argum
  17 |java.lang.management.RuntimeMXBean.getLibraryPath()|Returns the Java library p
  18 |java.lang.management.RuntimeMXBean.getManagementSpecVersion()|Returns the vers
  19 |java.lang.management.RuntimeMXBean.getName()|Returns the name representing the
  20 |java.lang.management.RuntimeMXBean.getSpecName()|Returns the Java virtual mach
  21 |java.lang.management.RuntimeMXBean.getSpecVendor()|Returns the Java virtual ma
  22 |java.lang.management.RuntimeMXBean.getSpecVersion()|Returns the Java virtual m
  23 |java.lang.management.RuntimeMXBean.getStartTime()|Returns the start time of th
  24 |java.lang.management.RuntimeMXBean.getSystemProperties()|Returns a map of name
  25 |java.lang.management.RuntimeMXBean.getUptime()|Returns the uptime of the Java
  26 |java.lang.management.RuntimeMXBean.getVmName()|Returns the Java virtual machin
  27 |java.lang.management.RuntimeMXBean.getVmVendor()|Returns the Java virtual mach
  28 |java.lang.management.RuntimeMXBean.getVmVersion()|Returns the Java virtual mac
  29 |java.lang.management.RuntimeMXBean.isBootClassPathSupported()|Tests if the Jav
  30
  31 *java.lang.management.RuntimeMXBean_Description*
  32
  33 The management interface for the runtime system of the Java virtual machine.
  34
  35 A Java virtual machine has a single instance of the implementation class of
  36 this interface. This instance implementing this interface is an MXBean that can
  37 be obtained by calling the (|java.lang.management.ManagementFactory|) method or
  38 from the platform
  39 <tt>MBeanServer</tt>(|java.lang.management.ManagementFactory|) method.
  40
  41 The ObjectName for uniquely identifying the MXBean for the runtime system
  42 within an MBeanServer is:
  43 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
  44
  45 This interface defines several convenient methods for accessing system
  46 properties about the Java virtual machine.
  47
  48
  49 *java.lang.management.RuntimeMXBean.getBootClassPath()*
  50
  51 public |java.lang.String| getBootClassPath()
  52
  53 Returns the boot class path that is used by the bootstrap class loader to
  54 search for class files.
  55
  56 Multiple paths in the boot class path are separated by the path separator
  57 character of the platform on which the Java virtual machine is running.
  58
  59 A Java virtual machine implementation may not support the boot class path
  60 mechanism for the bootstrap class loader to search for class files. The
  61 (|java.lang.management.RuntimeMXBean|) method can be used to determine if the
  62 Java virtual machine supports this method.
  63
  64
  65     Returns: the boot class path.
  66 *java.lang.management.RuntimeMXBean.getClassPath()*
  67
  68 public |java.lang.String| getClassPath()
  69
  70 Returns the Java class path that is used by the system class loader to search
  71 for class files. This method is equivalent to
  72 System.getProperty("java.class.path")(|java.lang.System|) .
  73
  74 Multiple paths in the Java class path are separated by the path separator
  75 character of the platform of the Java virtual machine being monitored.
  76
  77
  78     Returns: the Java class path.
  79 *java.lang.management.RuntimeMXBean.getInputArguments()*
  80
  81 public |java.util.List| getInputArguments()
  82
  83 Returns the input arguments passed to the Java virtual machine which does not
  84 include the arguments to the main method. This method returns an empty list if
  85 there is no input argument to the Java virtual machine.
  86
  87 Some Java virtual machine implementations may take input arguments from
  88 multiple different sources: for examples, arguments passed from the application
  89 that launches the Java virtual machine such as the 'java' command, environment
  90 variables, configuration files, etc.
  91
  92 Typically, not all command-line options to the 'java' command are passed to the
  93 Java virtual machine. Thus, the returned input arguments may not include all
  94 command-line options.
  95
  96 MBeanServer access: The mapped type of List is String[].
  97
  98
  99     Returns: a list of String objects; each element is an argument passed to the Java
 100              virtual machine.
 101 *java.lang.management.RuntimeMXBean.getLibraryPath()*
 102
 103 public |java.lang.String| getLibraryPath()
 104
 105 Returns the Java library path. This method is equivalent to
 106 System.getProperty("java.library.path")(|java.lang.System|) .
 107
 108 Multiple paths in the Java library path are separated by the path separator
 109 character of the platform of the Java virtual machine being monitored.
 110
 111
 112     Returns: the Java library path.
 113 *java.lang.management.RuntimeMXBean.getManagementSpecVersion()*
 114
 115 public |java.lang.String| getManagementSpecVersion()
 116
 117 Returns the version of the specification for the management interface
 118 implemented by the running Java virtual machine.
 119
 120
 121     Returns: the version of the specification for the management interface implemented by
 122              the running Java virtual machine.
 123 *java.lang.management.RuntimeMXBean.getName()*
 124
 125 public |java.lang.String| getName()
 126
 127 Returns the name representing the running Java virtual machine. The returned
 128 name string can be any arbitrary string and a Java virtual machine
 129 implementation can choose to embed platform-specific useful information in the
 130 returned name string. Each running virtual machine could have a different name.
 131
 132
 133     Returns: the name representing the running Java virtual machine.
 134 *java.lang.management.RuntimeMXBean.getSpecName()*
 135
 136 public |java.lang.String| getSpecName()
 137
 138 Returns the Java virtual machine specification name. This method is equivalent
 139 to System.getProperty("java.vm.specification.name")(|java.lang.System|) .
 140
 141
 142     Returns: the Java virtual machine specification name.
 143 *java.lang.management.RuntimeMXBean.getSpecVendor()*
 144
 145 public |java.lang.String| getSpecVendor()
 146
 147 Returns the Java virtual machine specification vendor. This method is
 148 equivalent to
 149 System.getProperty("java.vm.specification.vendor")(|java.lang.System|) .
 150
 151
 152     Returns: the Java virtual machine specification vendor.
 153 *java.lang.management.RuntimeMXBean.getSpecVersion()*
 154
 155 public |java.lang.String| getSpecVersion()
 156
 157 Returns the Java virtual machine specification version. This method is
 158 equivalent to
 159 System.getProperty("java.vm.specification.version")(|java.lang.System|) .
 160
 161
 162     Returns: the Java virtual machine specification version.
 163 *java.lang.management.RuntimeMXBean.getStartTime()*
 164
 165 public long getStartTime()
 166
 167 Returns the start time of the Java virtual machine in milliseconds. This method
 168 returns the approximate time when the Java virtual machine started.
 169
 170
 171     Returns: start time of the Java virtual machine in milliseconds.
 172 *java.lang.management.RuntimeMXBean.getSystemProperties()*
 173
 174 public |java.util.Map| getSystemProperties()
 175
 176 Returns a map of names and values of all system properties. This method calls
 177 (|java.lang.System|) to get all system properties. Properties whose name or
 178 value is not a String are omitted.
 179
 180 MBeanServer access: The mapped type of Map is
 181 TabularData(|javax.management.openmbean.TabularData|) with two items in each
 182 row as follows:
 183
 184
 185
 186 Item Name Item Type
 187
 188 key String
 189
 190 value String
 191
 192
 193
 194
 195     Returns: a map of names and values of all system properties.
 196 *java.lang.management.RuntimeMXBean.getUptime()*
 197
 198 public long getUptime()
 199
 200 Returns the uptime of the Java virtual machine in milliseconds.
 201
 202
 203     Returns: uptime of the Java virtual machine in milliseconds.
 204 *java.lang.management.RuntimeMXBean.getVmName()*
 205
 206 public |java.lang.String| getVmName()
 207
 208 Returns the Java virtual machine implementation name. This method is equivalent
 209 to System.getProperty("java.vm.name")(|java.lang.System|) .
 210
 211
 212     Returns: the Java virtual machine implementation name.
 213 *java.lang.management.RuntimeMXBean.getVmVendor()*
 214
 215 public |java.lang.String| getVmVendor()
 216
 217 Returns the Java virtual machine implementation vendor. This method is
 218 equivalent to System.getProperty("java.vm.vendor")(|java.lang.System|) .
 219
 220
 221     Returns: the Java virtual machine implementation vendor.
 222 *java.lang.management.RuntimeMXBean.getVmVersion()*
 223
 224 public |java.lang.String| getVmVersion()
 225
 226 Returns the Java virtual machine implementation version. This method is
 227 equivalent to System.getProperty("java.vm.version")(|java.lang.System|) .
 228
 229
 230     Returns: the Java virtual machine implementation version.
 231 *java.lang.management.RuntimeMXBean.isBootClassPathSupported()*
 232
 233 public boolean isBootClassPathSupported()
 234
 235 Tests if the Java virtual machine supports the boot class path mechanism used
 236 by the bootstrap class loader to search for class files.
 237
 238
 239     Returns: true if the Java virtual machine supports the class path mechanism; false
 240              otherwise.
 241