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
  50 *java.lang.management.RuntimeMXBean.getBootClassPath()*
  51
  52 public |java.lang.String| getBootClassPath()
  53
  54 Returns the boot class path that is used by the bootstrap class loader to
  55 search for class files.
  56
  57 Multiple paths in the boot class path are separated by the path separator
  58 character of the platform on which the Java virtual machine is running.
  59
  60 A Java virtual machine implementation may not support the boot class path
  61 mechanism for the bootstrap class loader to search for class files. The
  62 (|java.lang.management.RuntimeMXBean|) method can be used to determine if the
  63 Java virtual machine supports this method.
  64
  65
  66
  67     Returns: the boot class path.
  68
  69 *java.lang.management.RuntimeMXBean.getClassPath()*
  70
  71 public |java.lang.String| getClassPath()
  72
  73 Returns the Java class path that is used by the system class loader to search
  74 for class files. This method is equivalent to
  75 System.getProperty("java.class.path")(|java.lang.System|) .
  76
  77 Multiple paths in the Java class path are separated by the path separator
  78 character of the platform of the Java virtual machine being monitored.
  79
  80
  81
  82     Returns: the Java class path.
  83
  84 *java.lang.management.RuntimeMXBean.getInputArguments()*
  85
  86 public |java.util.List|<String> getInputArguments()
  87
  88 Returns the input arguments passed to the Java virtual machine which does not
  89 include the arguments to the main method. This method returns an empty list if
  90 there is no input argument to the Java virtual machine.
  91
  92 Some Java virtual machine implementations may take input arguments from
  93 multiple different sources: for examples, arguments passed from the application
  94 that launches the Java virtual machine such as the 'java' command, environment
  95 variables, configuration files, etc.
  96
  97 Typically, not all command-line options to the 'java' command are passed to the
  98 Java virtual machine. Thus, the returned input arguments may not include all
  99 command-line options.
 100
 101 MBeanServer access: The mapped type of List is String[].
 102
 103
 104
 105     Returns: a list of String objects; each element is an argument passed to the Java
 106              virtual machine.
 107
 108 *java.lang.management.RuntimeMXBean.getLibraryPath()*
 109
 110 public |java.lang.String| getLibraryPath()
 111
 112 Returns the Java library path. This method is equivalent to
 113 System.getProperty("java.library.path")(|java.lang.System|) .
 114
 115 Multiple paths in the Java library path are separated by the path separator
 116 character of the platform of the Java virtual machine being monitored.
 117
 118
 119
 120     Returns: the Java library path.
 121
 122 *java.lang.management.RuntimeMXBean.getManagementSpecVersion()*
 123
 124 public |java.lang.String| getManagementSpecVersion()
 125
 126 Returns the version of the specification for the management interface
 127 implemented by the running Java virtual machine.
 128
 129
 130
 131     Returns: the version of the specification for the management interface implemented by
 132              the running Java virtual machine.
 133
 134 *java.lang.management.RuntimeMXBean.getName()*
 135
 136 public |java.lang.String| getName()
 137
 138 Returns the name representing the running Java virtual machine. The returned
 139 name string can be any arbitrary string and a Java virtual machine
 140 implementation can choose to embed platform-specific useful information in the
 141 returned name string. Each running virtual machine could have a different name.
 142
 143
 144
 145     Returns: the name representing the running Java virtual machine.
 146
 147 *java.lang.management.RuntimeMXBean.getSpecName()*
 148
 149 public |java.lang.String| getSpecName()
 150
 151 Returns the Java virtual machine specification name. This method is equivalent
 152 to System.getProperty("java.vm.specification.name")(|java.lang.System|) .
 153
 154
 155
 156     Returns: the Java virtual machine specification name.
 157
 158 *java.lang.management.RuntimeMXBean.getSpecVendor()*
 159
 160 public |java.lang.String| getSpecVendor()
 161
 162 Returns the Java virtual machine specification vendor. This method is
 163 equivalent to
 164 System.getProperty("java.vm.specification.vendor")(|java.lang.System|) .
 165
 166
 167
 168     Returns: the Java virtual machine specification vendor.
 169
 170 *java.lang.management.RuntimeMXBean.getSpecVersion()*
 171
 172 public |java.lang.String| getSpecVersion()
 173
 174 Returns the Java virtual machine specification version. This method is
 175 equivalent to
 176 System.getProperty("java.vm.specification.version")(|java.lang.System|) .
 177
 178
 179
 180     Returns: the Java virtual machine specification version.
 181
 182 *java.lang.management.RuntimeMXBean.getStartTime()*
 183
 184 public long getStartTime()
 185
 186 Returns the start time of the Java virtual machine in milliseconds. This method
 187 returns the approximate time when the Java virtual machine started.
 188
 189
 190
 191     Returns: start time of the Java virtual machine in milliseconds.
 192
 193 *java.lang.management.RuntimeMXBean.getSystemProperties()*
 194
 195 public |java.util.Map|<String,String> getSystemProperties()
 196
 197 Returns a map of names and values of all system properties. This method calls
 198 (|java.lang.System|) to get all system properties. Properties whose name or
 199 value is not a String are omitted.
 200
 201 MBeanServer access: The mapped type of Map is
 202 TabularData(|javax.management.openmbean.TabularData|) with two items in each
 203 row as follows:
 204
 205
 206
 207 Item Name Item Type
 208
 209 key String
 210
 211 value String
 212
 213
 214
 215
 216
 217     Returns: a map of names and values of all system properties.
 218
 219 *java.lang.management.RuntimeMXBean.getUptime()*
 220
 221 public long getUptime()
 222
 223 Returns the uptime of the Java virtual machine in milliseconds.
 224
 225
 226
 227     Returns: uptime of the Java virtual machine in milliseconds.
 228
 229 *java.lang.management.RuntimeMXBean.getVmName()*
 230
 231 public |java.lang.String| getVmName()
 232
 233 Returns the Java virtual machine implementation name. This method is equivalent
 234 to System.getProperty("java.vm.name")(|java.lang.System|) .
 235
 236
 237
 238     Returns: the Java virtual machine implementation name.
 239
 240 *java.lang.management.RuntimeMXBean.getVmVendor()*
 241
 242 public |java.lang.String| getVmVendor()
 243
 244 Returns the Java virtual machine implementation vendor. This method is
 245 equivalent to System.getProperty("java.vm.vendor")(|java.lang.System|) .
 246
 247
 248
 249     Returns: the Java virtual machine implementation vendor.
 250
 251 *java.lang.management.RuntimeMXBean.getVmVersion()*
 252
 253 public |java.lang.String| getVmVersion()
 254
 255 Returns the Java virtual machine implementation version. This method is
 256 equivalent to System.getProperty("java.vm.version")(|java.lang.System|) .
 257
 258
 259
 260     Returns: the Java virtual machine implementation version.
 261
 262 *java.lang.management.RuntimeMXBean.isBootClassPathSupported()*
 263
 264 public boolean isBootClassPathSupported()
 265
 266 Tests if the Java virtual machine supports the boot class path mechanism used
 267 by the bootstrap class loader to search for class files.
 268
 269
 270
 271     Returns: true if the Java virtual machine supports the class path mechanism; false
 272              otherwise.
 273
 274