ohair | 92de566 | 2012-04-10 08:22:03 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Oracle designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Oracle in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 22 | * or visit www.oracle.com if you need additional information or have any |
| 23 | * questions. |
| 24 | */ |
| 25 | |
| 26 | JDWP "Java(tm) Debug Wire Protocol" |
| 27 | (CommandSet VirtualMachine=1 |
| 28 | (Command Version=1 |
| 29 | "Returns the JDWP version implemented by the target VM. " |
| 30 | "The version string format is implementation dependent. " |
| 31 | (Out |
| 32 | ) |
| 33 | (Reply |
| 34 | (string description "Text information on the VM version") |
| 35 | (int jdwpMajor "Major JDWP Version number") |
| 36 | (int jdwpMinor "Minor JDWP Version number") |
| 37 | (string vmVersion "Target VM JRE version, as in the java.version property") |
| 38 | (string vmName "Target VM name, as in the java.vm.name property") |
| 39 | ) |
| 40 | (ErrorSet |
| 41 | (Error VM_DEAD) |
| 42 | ) |
| 43 | ) |
| 44 | (Command ClassesBySignature=2 |
| 45 | "Returns reference types for all the classes loaded by the target VM " |
| 46 | "which match the given signature. " |
| 47 | "Multple reference types will be returned if two or more class " |
| 48 | "loaders have loaded a class of the same name. " |
| 49 | "The search is confined to loaded classes only; no attempt is made " |
| 50 | "to load a class of the given signature. " |
| 51 | (Out |
| 52 | (string signature "JNI signature of the class to find " |
| 53 | "(for example, \"Ljava/lang/String;\"). " |
| 54 | ) |
| 55 | ) |
| 56 | (Reply |
| 57 | (Repeat classes "Number of reference types that follow." |
| 58 | (Group ClassInfo |
| 59 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 60 | "of following reference type. ") |
| 61 | (referenceTypeID typeID "Matching loaded reference type") |
| 62 | (int status "The current class " |
| 63 | "<a href=\"#JDWP_ClassStatus\">status.</a> ") |
| 64 | ) |
| 65 | ) |
| 66 | ) |
| 67 | (ErrorSet |
| 68 | (Error VM_DEAD) |
| 69 | ) |
| 70 | ) |
| 71 | (Command AllClasses=3 |
| 72 | "Returns reference types for all classes currently loaded by the " |
| 73 | "target VM." |
| 74 | (Out |
| 75 | ) |
| 76 | (Reply |
| 77 | (Repeat classes "Number of reference types that follow." |
| 78 | (Group ClassInfo |
| 79 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 80 | "of following reference type. ") |
| 81 | (referenceTypeID typeID "Loaded reference type") |
| 82 | (string signature |
| 83 | "The JNI signature of the loaded reference type") |
| 84 | (int status "The current class " |
| 85 | "<a href=\"#JDWP_ClassStatus\">status.</a> ") |
| 86 | ) |
| 87 | ) |
| 88 | ) |
| 89 | (ErrorSet |
| 90 | (Error VM_DEAD) |
| 91 | ) |
| 92 | ) |
| 93 | (Command AllThreads=4 |
| 94 | "Returns all threads currently running in the target VM . " |
| 95 | "The returned list contains threads created through " |
| 96 | "java.lang.Thread, all native threads attached to " |
| 97 | "the target VM through JNI, and system threads created " |
| 98 | "by the target VM. Threads that have not yet been started " |
| 99 | "and threads that have completed their execution are not " |
| 100 | "included in the returned list. " |
| 101 | (Out |
| 102 | ) |
| 103 | (Reply |
| 104 | (Repeat threads "Number of threads that follow." |
| 105 | (threadObject thread "A running thread") |
| 106 | ) |
| 107 | ) |
| 108 | (ErrorSet |
| 109 | (Error VM_DEAD) |
| 110 | ) |
| 111 | ) |
| 112 | (Command TopLevelThreadGroups=5 |
| 113 | "Returns all thread groups that do not have a parent. This command " |
| 114 | "may be used as the first step in building a tree (or trees) of the " |
| 115 | "existing thread groups." |
| 116 | (Out |
| 117 | ) |
| 118 | (Reply |
| 119 | (Repeat groups "Number of thread groups that follow." |
| 120 | (threadGroupObject group "A top level thread group") |
| 121 | ) |
| 122 | ) |
| 123 | (ErrorSet |
| 124 | (Error VM_DEAD) |
| 125 | ) |
| 126 | ) |
| 127 | (Command Dispose=6 |
| 128 | "Invalidates this virtual machine mirror. " |
| 129 | "The communication channel to the target VM is closed, and " |
| 130 | "the target VM prepares to accept another subsequent connection " |
| 131 | "from this debugger or another debugger, including the " |
| 132 | "following tasks: " |
| 133 | "<ul>" |
| 134 | "<li>All event requests are cancelled. " |
| 135 | "<li>All threads suspended by the thread-level " |
| 136 | "<a href=\"#JDWP_ThreadReference_Resume\">resume</a> command " |
| 137 | "or the VM-level " |
| 138 | "<a href=\"#JDWP_VirtualMachine_Resume\">resume</a> command " |
| 139 | "are resumed as many times as necessary for them to run. " |
| 140 | "<li>Garbage collection is re-enabled in all cases where it was " |
| 141 | "<a href=\"#JDWP_ObjectReference_DisableCollection\">disabled</a> " |
| 142 | "</ul>" |
| 143 | "Any current method invocations executing in the target VM " |
| 144 | "are continued after the disconnection. Upon completion of any such " |
| 145 | "method invocation, the invoking thread continues from the " |
| 146 | "location where it was originally stopped. " |
| 147 | "<p>" |
| 148 | "Resources originating in " |
| 149 | "this VirtualMachine (ObjectReferences, ReferenceTypes, etc.) " |
| 150 | "will become invalid. " |
| 151 | (Out |
| 152 | ) |
| 153 | (Reply |
| 154 | ) |
| 155 | (ErrorSet |
| 156 | ) |
| 157 | ) |
| 158 | (Command IDSizes=7 |
| 159 | "Returns the sizes of variably-sized data types in the target VM." |
| 160 | "The returned values indicate the number of bytes used by the " |
| 161 | "identifiers in command and reply packets." |
| 162 | (Out |
| 163 | ) |
| 164 | (Reply |
| 165 | (int fieldIDSize "fieldID size in bytes ") |
| 166 | (int methodIDSize "methodID size in bytes ") |
| 167 | (int objectIDSize "objectID size in bytes ") |
| 168 | (int referenceTypeIDSize "referenceTypeID size in bytes ") |
| 169 | (int frameIDSize "frameID size in bytes ") |
| 170 | ) |
| 171 | (ErrorSet |
| 172 | (Error VM_DEAD) |
| 173 | ) |
| 174 | ) |
| 175 | (Command Suspend=8 |
| 176 | "Suspends the execution of the application running in the target " |
| 177 | "VM. All Java threads currently running will be suspended. " |
| 178 | "<p>" |
| 179 | "Unlike java.lang.Thread.suspend, " |
| 180 | "suspends of both the virtual machine and individual threads are " |
| 181 | "counted. Before a thread will run again, it must be resumed through " |
| 182 | "the <a href=\"#JDWP_VirtualMachine_Resume\">VM-level resume</a> command " |
| 183 | "or the <a href=\"#JDWP_ThreadReference_Resume\">thread-level resume</a> command " |
| 184 | "the same number of times it has been suspended. " |
| 185 | (Out |
| 186 | ) |
| 187 | (Reply |
| 188 | ) |
| 189 | (ErrorSet |
| 190 | (Error VM_DEAD) |
| 191 | ) |
| 192 | ) |
| 193 | (Command Resume=9 |
| 194 | "Resumes execution of the application after the suspend " |
| 195 | "command or an event has stopped it. " |
| 196 | "Suspensions of the Virtual Machine and individual threads are " |
| 197 | "counted. If a particular thread is suspended n times, it must " |
| 198 | "resumed n times before it will continue. " |
| 199 | (Out |
| 200 | ) |
| 201 | (Reply |
| 202 | ) |
| 203 | (ErrorSet |
| 204 | ) |
| 205 | ) |
| 206 | (Command Exit=10 |
| 207 | "Terminates the target VM with the given exit code. " |
| 208 | "On some platforms, the exit code might be truncated, for " |
| 209 | "example, to the low order 8 bits. " |
| 210 | "All ids previously returned from the target VM become invalid. " |
| 211 | "Threads running in the VM are abruptly terminated. " |
| 212 | "A thread death exception is not thrown and " |
| 213 | "finally blocks are not run." |
| 214 | (Out |
| 215 | (int exitCode "the exit code") |
| 216 | ) |
| 217 | (Reply |
| 218 | ) |
| 219 | (ErrorSet |
| 220 | ) |
| 221 | ) |
| 222 | (Command CreateString=11 |
| 223 | "Creates a new string object in the target VM and returns " |
| 224 | "its id. " |
| 225 | (Out |
| 226 | (string utf "UTF-8 characters to use in the created string. ") |
| 227 | ) |
| 228 | (Reply |
| 229 | (stringObject stringObject |
| 230 | "Created string (instance of java.lang.String) ") |
| 231 | ) |
| 232 | (ErrorSet |
| 233 | (Error VM_DEAD) |
| 234 | ) |
| 235 | ) |
| 236 | (Command Capabilities=12 |
| 237 | "Retrieve this VM's capabilities. The capabilities are returned " |
| 238 | "as booleans, each indicating the presence or absence of a " |
| 239 | "capability. The commands associated with each capability will " |
| 240 | "return the NOT_IMPLEMENTED error if the cabability is not " |
| 241 | "available." |
| 242 | (Out |
| 243 | ) |
| 244 | (Reply |
| 245 | (boolean canWatchFieldModification |
| 246 | "Can the VM watch field modification, and therefore " |
| 247 | "can it send the Modification Watchpoint Event?") |
| 248 | (boolean canWatchFieldAccess |
| 249 | "Can the VM watch field access, and therefore " |
| 250 | "can it send the Access Watchpoint Event?") |
| 251 | (boolean canGetBytecodes |
| 252 | "Can the VM get the bytecodes of a given method? ") |
| 253 | (boolean canGetSyntheticAttribute |
| 254 | "Can the VM determine whether a field or method is " |
| 255 | "synthetic? (that is, can the VM determine if the " |
| 256 | "method or the field was invented by the compiler?) ") |
| 257 | (boolean canGetOwnedMonitorInfo |
| 258 | "Can the VM get the owned monitors infornation for " |
| 259 | "a thread?") |
| 260 | (boolean canGetCurrentContendedMonitor |
| 261 | "Can the VM get the current contended monitor of a thread?") |
| 262 | (boolean canGetMonitorInfo |
| 263 | "Can the VM get the monitor information for a given object? ") |
| 264 | ) |
| 265 | (ErrorSet |
| 266 | (Error VM_DEAD) |
| 267 | ) |
| 268 | ) |
| 269 | (Command ClassPaths=13 |
| 270 | "Retrieve the classpath and bootclasspath of the target VM. " |
| 271 | "If the classpath is not defined, returns an empty list. If the " |
| 272 | "bootclasspath is not defined returns an empty list." |
| 273 | (Out |
| 274 | ) |
| 275 | (Reply |
| 276 | (string baseDir "Base directory used to resolve relative " |
| 277 | "paths in either of the following lists.") |
| 278 | (Repeat classpaths "Number of paths in classpath." |
| 279 | (string path "One component of classpath") ) |
| 280 | (Repeat bootclasspaths "Number of paths in bootclasspath." |
| 281 | (string path "One component of bootclasspath") ) |
| 282 | ) |
| 283 | (ErrorSet |
| 284 | (Error VM_DEAD) |
| 285 | ) |
| 286 | ) |
| 287 | (Command DisposeObjects=14 |
| 288 | "Releases a list of object IDs. For each object in the list, the " |
| 289 | "following applies. " |
| 290 | "The count of references held by the back-end (the reference " |
| 291 | "count) will be decremented by refCnt. " |
| 292 | "If thereafter the reference count is less than " |
| 293 | "or equal to zero, the ID is freed. " |
| 294 | "Any back-end resources associated with the freed ID may " |
| 295 | "be freed, and if garbage collection was " |
| 296 | "disabled for the object, it will be re-enabled. " |
| 297 | "The sender of this command " |
| 298 | "promises that no further commands will be sent " |
| 299 | "referencing a freed ID. |
| 300 | "<p>" |
| 301 | "Use of this command is not required. If it is not sent, " |
| 302 | "resources associated with each ID will be freed by the back-end " |
| 303 | "at some time after the corresponding object is garbage collected. " |
| 304 | "It is most useful to use this command to reduce the load on the " |
| 305 | "back-end if a very large number of " |
| 306 | "objects has been retrieved from the back-end (a large array, " |
| 307 | "for example) but may not be garbage collected any time soon. " |
| 308 | "<p>" |
| 309 | "IDs may be re-used by the back-end after they " |
| 310 | "have been freed with this command." |
| 311 | "This description assumes reference counting, " |
| 312 | "a back-end may use any implementation which operates " |
| 313 | "equivalently. " |
| 314 | (Out |
| 315 | (Repeat requests "Number of object dispose requests that follow" |
| 316 | (Group Request |
| 317 | (object object "The object ID") |
| 318 | (int refCnt "The number of times this object ID has been " |
| 319 | "part of a packet received from the back-end. " |
| 320 | "An accurate count prevents the object ID " |
| 321 | "from being freed on the back-end if " |
| 322 | "it is part of an incoming packet, not yet " |
| 323 | "handled by the front-end.") |
| 324 | ) |
| 325 | ) |
| 326 | ) |
| 327 | (Reply |
| 328 | ) |
| 329 | (ErrorSet |
| 330 | ) |
| 331 | ) |
| 332 | (Command HoldEvents=15 |
| 333 | "Tells the target VM to stop sending events. Events are not discarded; " |
| 334 | "they are held until a subsequent ReleaseEvents command is sent. " |
| 335 | "This command is useful to control the number of events sent " |
| 336 | "to the debugger VM in situations where very large numbers of events " |
| 337 | "are generated. " |
| 338 | "While events are held by the debugger back-end, application " |
| 339 | "execution may be frozen by the debugger back-end to prevent " |
| 340 | "buffer overflows on the back end. |
| 341 | "Responses to commands are never held and are not affected by this |
| 342 | "command. If events are already being held, this command is " |
| 343 | "ignored." |
| 344 | (Out |
| 345 | ) |
| 346 | (Reply |
| 347 | ) |
| 348 | (ErrorSet |
| 349 | ) |
| 350 | ) |
| 351 | (Command ReleaseEvents=16 |
| 352 | "Tells the target VM to continue sending events. This command is " |
| 353 | "used to restore normal activity after a HoldEvents command. If " |
| 354 | "there is no current HoldEvents command in effect, this command is " |
| 355 | "ignored." |
| 356 | (Out |
| 357 | ) |
| 358 | (Reply |
| 359 | ) |
| 360 | (ErrorSet |
| 361 | ) |
| 362 | ) |
| 363 | (Command CapabilitiesNew=17 |
| 364 | "Retrieve all of this VM's capabilities. The capabilities are returned " |
| 365 | "as booleans, each indicating the presence or absence of a " |
| 366 | "capability. The commands associated with each capability will " |
| 367 | "return the NOT_IMPLEMENTED error if the cabability is not " |
| 368 | "available." |
| 369 | "Since JDWP version 1.4." |
| 370 | (Out |
| 371 | ) |
| 372 | (Reply |
| 373 | (boolean canWatchFieldModification |
| 374 | "Can the VM watch field modification, and therefore " |
| 375 | "can it send the Modification Watchpoint Event?") |
| 376 | (boolean canWatchFieldAccess |
| 377 | "Can the VM watch field access, and therefore " |
| 378 | "can it send the Access Watchpoint Event?") |
| 379 | (boolean canGetBytecodes |
| 380 | "Can the VM get the bytecodes of a given method? ") |
| 381 | (boolean canGetSyntheticAttribute |
| 382 | "Can the VM determine whether a field or method is " |
| 383 | "synthetic? (that is, can the VM determine if the " |
| 384 | "method or the field was invented by the compiler?) ") |
| 385 | (boolean canGetOwnedMonitorInfo |
| 386 | "Can the VM get the owned monitors infornation for " |
| 387 | "a thread?") |
| 388 | (boolean canGetCurrentContendedMonitor |
| 389 | "Can the VM get the current contended monitor of a thread?") |
| 390 | (boolean canGetMonitorInfo |
| 391 | "Can the VM get the monitor information for a given object? ") |
| 392 | (boolean canRedefineClasses |
| 393 | "Can the VM redefine classes?") |
| 394 | (boolean canAddMethod |
| 395 | "Can the VM add methods when redefining " |
| 396 | "classes?") |
| 397 | (boolean canUnrestrictedlyRedefineClasses |
| 398 | "Can the VM redefine classes" |
| 399 | "in arbitrary ways?") |
| 400 | (boolean canPopFrames |
| 401 | "Can the VM pop stack frames?") |
| 402 | (boolean canUseInstanceFilters |
| 403 | "Can the VM filter events by specific object?") |
| 404 | (boolean canGetSourceDebugExtension |
| 405 | "Can the VM get the source debug extension?") |
| 406 | (boolean canRequestVMDeathEvent |
| 407 | "Can the VM request VM death events?") |
| 408 | (boolean canSetDefaultStratum |
| 409 | "Can the VM set a default stratum?") |
| 410 | (boolean canGetInstanceInfo |
| 411 | "Can the VM return instances, counts of instances of classes " |
| 412 | "and referring objects?") |
| 413 | (boolean canRequestMonitorEvents |
| 414 | "Can the VM request monitor events?") |
| 415 | (boolean canGetMonitorFrameInfo |
| 416 | "Can the VM get monitors with frame depth info?") |
| 417 | (boolean canUseSourceNameFilters |
| 418 | "Can the VM filter class prepare events by source name?") |
| 419 | (boolean canGetConstantPool |
| 420 | "Can the VM return the constant pool information?") |
| 421 | (boolean canForceEarlyReturn |
| 422 | "Can the VM force early return from a method?") |
| 423 | (boolean reserved22 |
| 424 | "Reserved for future capability") |
| 425 | (boolean reserved23 |
| 426 | "Reserved for future capability") |
| 427 | (boolean reserved24 |
| 428 | "Reserved for future capability") |
| 429 | (boolean reserved25 |
| 430 | "Reserved for future capability") |
| 431 | (boolean reserved26 |
| 432 | "Reserved for future capability") |
| 433 | (boolean reserved27 |
| 434 | "Reserved for future capability") |
| 435 | (boolean reserved28 |
| 436 | "Reserved for future capability") |
| 437 | (boolean reserved29 |
| 438 | "Reserved for future capability") |
| 439 | (boolean reserved30 |
| 440 | "Reserved for future capability") |
| 441 | (boolean reserved31 |
| 442 | "Reserved for future capability") |
| 443 | (boolean reserved32 |
| 444 | "Reserved for future capability") |
| 445 | ) |
| 446 | (ErrorSet |
| 447 | (Error VM_DEAD) |
| 448 | ) |
| 449 | ) |
| 450 | (Command RedefineClasses=18 |
| 451 | "Installs new class definitions. " |
| 452 | "If there are active stack frames in methods of the redefined classes in the " |
| 453 | "target VM then those active frames continue to run the bytecodes of the " |
| 454 | "original method. These methods are considered obsolete - see " |
| 455 | "<a href=\"#JDWP_Method_IsObsolete\">IsObsolete</a>. The methods in the " |
| 456 | "redefined classes will be used for new invokes in the target VM. " |
| 457 | "The original method ID refers to the redefined method. " |
| 458 | "All breakpoints in the redefined classes are cleared." |
| 459 | "If resetting of stack frames is desired, the " |
| 460 | "<a href=\"#JDWP_StackFrame_PopFrames\">PopFrames</a> command can be used " |
| 461 | "to pop frames with obsolete methods." |
| 462 | "<p>" |
| 463 | "Requires canRedefineClasses capability - see " |
| 464 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 465 | "In addition to the canRedefineClasses capability, the target VM must " |
| 466 | "have the canAddMethod capability to add methods when redefining classes, " |
| 467 | "or the canUnrestrictedlyRedefineClasses to redefine classes in arbitrary " |
| 468 | "ways." |
| 469 | (Out |
| 470 | (Repeat classes "Number of reference types that follow." |
| 471 | (Group ClassDef |
| 472 | (referenceType refType "The reference type.") |
| 473 | (Repeat classfile "Number of bytes defining class (below)" |
| 474 | (byte classbyte "byte in JVM class file " |
| 475 | "format.") |
| 476 | ) |
| 477 | ) |
| 478 | ) |
| 479 | ) |
| 480 | (Reply |
| 481 | ) |
| 482 | (ErrorSet |
| 483 | (Error INVALID_CLASS "One of the refTypes is not the ID of a reference " |
| 484 | "type.") |
| 485 | (Error INVALID_OBJECT "One of the refTypes is not a known ID.") |
| 486 | (Error UNSUPPORTED_VERSION) |
| 487 | (Error INVALID_CLASS_FORMAT) |
| 488 | (Error CIRCULAR_CLASS_DEFINITION) |
| 489 | (Error FAILS_VERIFICATION) |
| 490 | (Error NAMES_DONT_MATCH) |
| 491 | (Error NOT_IMPLEMENTED "No aspect of this functionality is implemented " |
| 492 | "(CapabilitiesNew.canRedefineClasses is false)") |
| 493 | (Error ADD_METHOD_NOT_IMPLEMENTED) |
| 494 | (Error SCHEMA_CHANGE_NOT_IMPLEMENTED) |
| 495 | (Error HIERARCHY_CHANGE_NOT_IMPLEMENTED) |
| 496 | (Error DELETE_METHOD_NOT_IMPLEMENTED) |
| 497 | (Error CLASS_MODIFIERS_CHANGE_NOT_IMPLEMENTED) |
| 498 | (Error METHOD_MODIFIERS_CHANGE_NOT_IMPLEMENTED) |
| 499 | (Error VM_DEAD) |
| 500 | ) |
| 501 | ) |
| 502 | (Command SetDefaultStratum=19 |
| 503 | "Set the default stratum. Requires canSetDefaultStratum capability - see " |
| 504 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 505 | (Out |
| 506 | (string stratumID "default stratum, or empty string to use " |
| 507 | "reference type default.") |
| 508 | ) |
| 509 | (Reply |
| 510 | ) |
| 511 | (ErrorSet |
| 512 | (Error NOT_IMPLEMENTED) |
| 513 | (Error VM_DEAD) |
| 514 | ) |
| 515 | ) |
| 516 | (Command AllClassesWithGeneric=20 |
| 517 | "Returns reference types for all classes currently loaded by the " |
| 518 | "target VM. " |
| 519 | "Both the JNI signature and the generic signature are " |
| 520 | "returned for each class. " |
| 521 | "Generic signatures are described in the signature attribute " |
| 522 | "section in " |
| 523 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 524 | "Since JDWP version 1.5." |
| 525 | (Out |
| 526 | ) |
| 527 | (Reply |
| 528 | (Repeat classes "Number of reference types that follow." |
| 529 | (Group ClassInfo |
| 530 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 531 | "of following reference type. ") |
| 532 | (referenceTypeID typeID "Loaded reference type") |
| 533 | (string signature |
| 534 | "The JNI signature of the loaded reference type.") |
| 535 | (string genericSignature |
| 536 | "The generic signature of the loaded reference type " |
| 537 | "or an empty string if there is none.") |
| 538 | (int status "The current class " |
| 539 | "<a href=\"#JDWP_ClassStatus\">status.</a> ") |
| 540 | ) |
| 541 | ) |
| 542 | ) |
| 543 | (ErrorSet |
| 544 | (Error VM_DEAD) |
| 545 | ) |
| 546 | ) |
| 547 | |
| 548 | (Command InstanceCounts=21 |
| 549 | "Returns the number of instances of each reference type in the input list. " |
| 550 | "Only instances that are reachable for the purposes of " |
| 551 | "garbage collection are counted. If a reference type is invalid, " |
| 552 | "eg. it has been unloaded, zero is returned for its instance count." |
| 553 | "<p>Since JDWP version 1.6. Requires canGetInstanceInfo capability - see " |
| 554 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 555 | (Out |
| 556 | (Repeat refTypesCount "Number of reference types that follow. Must be non-negative." |
| 557 | (referenceType refType "A reference type ID.") |
| 558 | ) |
| 559 | ) |
| 560 | (Reply |
| 561 | (Repeat counts "The number of counts that follow." |
| 562 | (long instanceCount "The number of instances for the corresponding reference type " |
| 563 | "in 'Out Data'.") |
| 564 | ) |
| 565 | ) |
| 566 | (ErrorSet |
| 567 | (Error ILLEGAL_ARGUMENT "refTypesCount is less than zero.") |
| 568 | (Error NOT_IMPLEMENTED) |
| 569 | (Error VM_DEAD) |
| 570 | ) |
| 571 | ) |
| 572 | ) |
| 573 | |
| 574 | (CommandSet ReferenceType=2 |
| 575 | (Command Signature=1 |
| 576 | "Returns the JNI signature of a reference type. " |
| 577 | "JNI signature formats are described in the " |
| 578 | "<a href=\"http://java.sun.com/products/jdk/1.2/docs/guide/jni/index.html\">Java Native Inteface Specification</a>" |
| 579 | "<p> |
| 580 | "For primitive classes " |
| 581 | "the returned signature is the signature of the corresponding primitive " |
| 582 | "type; for example, \"I\" is returned as the signature of the class " |
| 583 | "represented by java.lang.Integer.TYPE." |
| 584 | (Out |
| 585 | (referenceType refType "The reference type ID.") |
| 586 | ) |
| 587 | (Reply |
| 588 | (string signature |
| 589 | "The JNI signature for the reference type.") |
| 590 | ) |
| 591 | (ErrorSet |
| 592 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 593 | "type.") |
| 594 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 595 | (Error VM_DEAD) |
| 596 | ) |
| 597 | ) |
| 598 | (Command ClassLoader=2 |
| 599 | "Returns the instance of java.lang.ClassLoader which loaded " |
| 600 | "a given reference type. If the reference type was loaded by the " |
| 601 | "system class loader, the returned object ID is null." |
| 602 | (Out |
| 603 | (referenceType refType "The reference type ID.") |
| 604 | ) |
| 605 | (Reply |
| 606 | (classLoaderObject classLoader "The class loader for the reference type. ") |
| 607 | ) |
| 608 | (ErrorSet |
| 609 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 610 | "type.") |
| 611 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 612 | (Error VM_DEAD) |
| 613 | ) |
| 614 | ) |
| 615 | (Command Modifiers=3 |
| 616 | "Returns the modifiers (also known as access flags) for a reference type. " |
| 617 | "The returned bit mask contains information on the declaration " |
| 618 | "of the reference type. If the reference type is an array or " |
| 619 | "a primitive class (for example, java.lang.Integer.TYPE), the " |
| 620 | "value of the returned bit mask is undefined." |
| 621 | (Out |
| 622 | (referenceType refType "The reference type ID.") |
| 623 | ) |
| 624 | (Reply |
| 625 | (int modBits "Modifier bits as defined in Chapter 4 of " |
| 626 | "<cite>The Java™ Virtual Machine Specification</cite>") |
| 627 | ) |
| 628 | (ErrorSet |
| 629 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 630 | "type.") |
| 631 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 632 | (Error VM_DEAD) |
| 633 | ) |
| 634 | ) |
| 635 | (Command Fields=4 |
| 636 | "Returns information for each field in a reference type. " |
| 637 | "Inherited fields are not included. " |
| 638 | "The field list will include any synthetic fields created " |
| 639 | "by the compiler. " |
| 640 | "Fields are returned in the order they occur in the class file." |
| 641 | (Out |
| 642 | (referenceType refType "The reference type ID.") |
| 643 | ) |
| 644 | (Reply |
| 645 | (Repeat declared "Number of declared fields." |
| 646 | (Group FieldInfo |
| 647 | (field fieldID "Field ID.") |
| 648 | (string name "Name of field.") |
| 649 | (string signature "JNI Signature of field.") |
| 650 | (int modBits "The modifier bit flags (also known as access flags) " |
| 651 | "which provide additional information on the " |
| 652 | "field declaration. Individual flag values are " |
| 653 | "defined in Chapter 4 of " |
| 654 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 655 | "In addition, The <code>0xf0000000</code> bit identifies " |
| 656 | "the field as synthetic, if the synthetic attribute " |
| 657 | "<a href=\"#JDWP_VirtualMachine_Capabilities\">capability</a> is available.") |
| 658 | ) |
| 659 | ) |
| 660 | ) |
| 661 | (ErrorSet |
| 662 | (Error CLASS_NOT_PREPARED) |
| 663 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 664 | "type.") |
| 665 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 666 | (Error VM_DEAD) |
| 667 | ) |
| 668 | ) |
| 669 | (Command Methods=5 |
| 670 | "Returns information for each method in a reference type. " |
| 671 | "Inherited methods are not included. The list of methods will " |
| 672 | "include constructors (identified with the name \"<init>\"), " |
| 673 | "the initialization method (identified with the name \"<clinit>\") " |
| 674 | "if present, and any synthetic methods created by the compiler. " |
| 675 | "Methods are returned in the order they occur in the class file." |
| 676 | (Out |
| 677 | (referenceType refType "The reference type ID.") |
| 678 | ) |
| 679 | (Reply |
| 680 | (Repeat declared "Number of declared methods." |
| 681 | (Group MethodInfo |
| 682 | (method methodID "Method ID.") |
| 683 | (string name "Name of method.") |
| 684 | (string signature "JNI signature of method.") |
| 685 | (int modBits "The modifier bit flags (also known as access flags) " |
| 686 | "which provide additional information on the " |
| 687 | "method declaration. Individual flag values are " |
| 688 | "defined in Chapter 4 of " |
| 689 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 690 | "In addition, The <code>0xf0000000</code> bit identifies " |
| 691 | "the method as synthetic, if the synthetic attribute " |
| 692 | "<a href=\"#JDWP_VirtualMachine_Capabilities\">capability</a> is available.") |
| 693 | ) |
| 694 | ) |
| 695 | ) |
| 696 | (ErrorSet |
| 697 | (Error CLASS_NOT_PREPARED) |
| 698 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 699 | "type.") |
| 700 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 701 | (Error VM_DEAD) |
| 702 | ) |
| 703 | ) |
| 704 | (Command GetValues=6 |
| 705 | "Returns the value of one or more static fields of the " |
| 706 | "reference type. Each field must be member of the reference type " |
| 707 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 708 | "Access control is not enforced; for example, the values of private " |
| 709 | "fields can be obtained." |
| 710 | (Out |
| 711 | (referenceType refType "The reference type ID.") |
| 712 | (Repeat fields "The number of values to get" |
| 713 | (Group Field |
| 714 | (field fieldID "A field to get") |
| 715 | ) |
| 716 | ) |
| 717 | ) |
| 718 | (Reply |
| 719 | (Repeat values "The number of values returned, always equal to fields, " |
| 720 | "the number of values to get." |
| 721 | (value value "The field value") |
| 722 | ) |
| 723 | ) |
| 724 | (ErrorSet |
| 725 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 726 | "type.") |
| 727 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 728 | (Error INVALID_FIELDID) |
| 729 | (Error VM_DEAD) |
| 730 | ) |
| 731 | ) |
| 732 | (Command SourceFile=7 |
| 733 | "Returns the name of source file in which a reference type was " |
| 734 | "declared. " |
| 735 | (Out |
| 736 | (referenceType refType "The reference type ID.") |
| 737 | ) |
| 738 | (Reply |
| 739 | (string sourceFile "The source file name. No path information " |
| 740 | "for the file is included") |
| 741 | ) |
| 742 | (ErrorSet |
| 743 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 744 | "type.") |
| 745 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 746 | (Error ABSENT_INFORMATION "The source file attribute is absent.") |
| 747 | (Error VM_DEAD) |
| 748 | ) |
| 749 | ) |
| 750 | (Command NestedTypes=8 |
| 751 | "Returns the classes and interfaces directly nested within this type." |
| 752 | "Types further nested within those types are not included. " |
| 753 | (Out |
| 754 | (referenceType refType "The reference type ID.") |
| 755 | ) |
| 756 | (Reply |
| 757 | (Repeat classes "The number of nested classes and interfaces" |
| 758 | (Group TypeInfo |
| 759 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 760 | "of following reference type. ") |
| 761 | (referenceTypeID typeID "The nested class or interface ID.") |
| 762 | ) |
| 763 | ) |
| 764 | ) |
| 765 | (ErrorSet |
| 766 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 767 | "type.") |
| 768 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 769 | (Error VM_DEAD) |
| 770 | ) |
| 771 | ) |
| 772 | (Command Status=9 |
| 773 | "Returns the current status of the reference type. The status " |
| 774 | "indicates the extent to which the reference type has been " |
| 775 | "initialized, as described in section 2.1.6 of " |
| 776 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 777 | "If the class is linked the PREPARED and VERIFIED bits in the returned status bits " |
| 778 | "will be set. If the class is initialized the INITIALIZED bit in the returned " |
| 779 | "status bits will be set. If an error occured during initialization then the " |
| 780 | "ERROR bit in the returned status bits will be set. " |
| 781 | "The returned status bits are undefined for array types and for " |
| 782 | "primitive classes (such as java.lang.Integer.TYPE). " |
| 783 | (Out |
| 784 | (referenceType refType "The reference type ID.") |
| 785 | ) |
| 786 | (Reply |
| 787 | (int status "<a href=\"#JDWP_ClassStatus\">Status</a> bits:" |
| 788 | "See <a href=\"#JDWP_ClassStatus\">JDWP.ClassStatus</a>") |
| 789 | ) |
| 790 | (ErrorSet |
| 791 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 792 | "type.") |
| 793 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 794 | (Error VM_DEAD) |
| 795 | ) |
| 796 | ) |
| 797 | (Command Interfaces=10 |
| 798 | "Returns the interfaces declared as implemented by this class. " |
| 799 | "Interfaces indirectly implemented (extended by the implemented " |
| 800 | "interface or implemented by a superclass) are not included." |
| 801 | (Out |
| 802 | (referenceType refType "The reference type ID.") |
| 803 | ) |
| 804 | (Reply |
| 805 | (Repeat interfaces "The number of implemented interfaces" |
| 806 | (interfaceType interfaceType "implemented interface.") |
| 807 | ) |
| 808 | ) |
| 809 | (ErrorSet |
| 810 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 811 | "type.") |
| 812 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 813 | (Error VM_DEAD) |
| 814 | ) |
| 815 | ) |
| 816 | (Command ClassObject=11 |
| 817 | "Returns the class object corresponding to this type. " |
| 818 | (Out |
| 819 | (referenceType refType "The reference type ID.") |
| 820 | ) |
| 821 | (Reply |
| 822 | (classObject classObject "class object.") |
| 823 | ) |
| 824 | (ErrorSet |
| 825 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 826 | "type.") |
| 827 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 828 | (Error VM_DEAD) |
| 829 | ) |
| 830 | ) |
| 831 | (Command SourceDebugExtension=12 |
| 832 | "Returns the value of the SourceDebugExtension attribute. " |
| 833 | "Since JDWP version 1.4. Requires canGetSourceDebugExtension capability - see " |
| 834 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 835 | (Out |
| 836 | (referenceType refType "The reference type ID.") |
| 837 | ) |
| 838 | (Reply |
| 839 | (string extension "extension attribute") |
| 840 | ) |
| 841 | (ErrorSet |
| 842 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 843 | "type.") |
| 844 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 845 | (Error ABSENT_INFORMATION "If the extension is not specified.") |
| 846 | (Error NOT_IMPLEMENTED) |
| 847 | (Error VM_DEAD) |
| 848 | ) |
| 849 | ) |
| 850 | (Command SignatureWithGeneric=13 |
| 851 | "Returns the JNI signature of a reference type along with the " |
| 852 | "generic signature if there is one. " |
| 853 | "Generic signatures are described in the signature attribute " |
| 854 | "section in " |
| 855 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 856 | "Since JDWP version 1.5." |
| 857 | "<p> |
| 858 | (Out |
| 859 | (referenceType refType "The reference type ID.") |
| 860 | ) |
| 861 | (Reply |
| 862 | (string signature |
| 863 | "The JNI signature for the reference type.") |
| 864 | (string genericSignature |
| 865 | "The generic signature for the reference type or an empty " |
| 866 | "string if there is none.") |
| 867 | ) |
| 868 | (ErrorSet |
| 869 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 870 | "type.") |
| 871 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 872 | (Error VM_DEAD) |
| 873 | ) |
| 874 | ) |
| 875 | (Command FieldsWithGeneric=14 |
| 876 | "Returns information, including the generic signature if any, " |
| 877 | "for each field in a reference type. " |
| 878 | "Inherited fields are not included. " |
| 879 | "The field list will include any synthetic fields created " |
| 880 | "by the compiler. " |
| 881 | "Fields are returned in the order they occur in the class file. " |
| 882 | "Generic signatures are described in the signature attribute " |
| 883 | "section in " |
| 884 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 885 | "Since JDWP version 1.5." |
| 886 | (Out |
| 887 | (referenceType refType "The reference type ID.") |
| 888 | ) |
| 889 | (Reply |
| 890 | (Repeat declared "Number of declared fields." |
| 891 | (Group FieldInfo |
| 892 | (field fieldID "Field ID.") |
| 893 | (string name "The name of the field.") |
| 894 | (string signature "The JNI signature of the field.") |
| 895 | (string genericSignature "The generic signature of the " |
| 896 | "field, or an empty string if there is none.") |
| 897 | (int modBits "The modifier bit flags (also known as access flags) " |
| 898 | "which provide additional information on the " |
| 899 | "field declaration. Individual flag values are " |
| 900 | "defined in Chapter 4 of " |
| 901 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 902 | "In addition, The <code>0xf0000000</code> bit identifies " |
| 903 | "the field as synthetic, if the synthetic attribute " |
| 904 | "<a href=\"#JDWP_VirtualMachine_Capabilities\">capability</a> is available.") |
| 905 | ) |
| 906 | ) |
| 907 | ) |
| 908 | (ErrorSet |
| 909 | (Error CLASS_NOT_PREPARED) |
| 910 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 911 | "type.") |
| 912 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 913 | (Error VM_DEAD) |
| 914 | ) |
| 915 | ) |
| 916 | (Command MethodsWithGeneric=15 |
| 917 | "Returns information, including the generic signature if any, " |
| 918 | "for each method in a reference type. " |
| 919 | "Inherited methodss are not included. The list of methods will " |
| 920 | "include constructors (identified with the name \"<init>\"), " |
| 921 | "the initialization method (identified with the name \"<clinit>\") " |
| 922 | "if present, and any synthetic methods created by the compiler. " |
| 923 | "Methods are returned in the order they occur in the class file. " |
| 924 | "Generic signatures are described in the signature attribute " |
| 925 | "section in " |
| 926 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 927 | "Since JDWP version 1.5." |
| 928 | (Out |
| 929 | (referenceType refType "The reference type ID.") |
| 930 | ) |
| 931 | (Reply |
| 932 | (Repeat declared "Number of declared methods." |
| 933 | (Group MethodInfo |
| 934 | (method methodID "Method ID.") |
| 935 | (string name "The name of the method.") |
| 936 | (string signature "The JNI signature of the method.") |
| 937 | (string genericSignature "The generic signature of the method, or " |
| 938 | "an empty string if there is none.") |
| 939 | (int modBits "The modifier bit flags (also known as access flags) " |
| 940 | "which provide additional information on the " |
| 941 | "method declaration. Individual flag values are " |
| 942 | "defined in Chapter 4 of " |
| 943 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 944 | "In addition, The <code>0xf0000000</code> bit identifies " |
| 945 | "the method as synthetic, if the synthetic attribute " |
| 946 | "<a href=\"#JDWP_VirtualMachine_Capabilities\">capability</a> is available.") |
| 947 | ) |
| 948 | ) |
| 949 | ) |
| 950 | (ErrorSet |
| 951 | (Error CLASS_NOT_PREPARED) |
| 952 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 953 | "type.") |
| 954 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 955 | (Error VM_DEAD) |
| 956 | ) |
| 957 | ) |
| 958 | (Command Instances=16 |
| 959 | "Returns instances of this reference type. " |
| 960 | "Only instances that are reachable for the purposes of " |
| 961 | "garbage collection are returned. " |
| 962 | "<p>Since JDWP version 1.6. Requires canGetInstanceInfo capability - see " |
| 963 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 964 | (Out |
| 965 | (referenceType refType "The reference type ID.") |
| 966 | (int maxInstances "Maximum number of instances to return. Must be non-negative. " |
| 967 | "If zero, all instances are returned.") |
| 968 | ) |
| 969 | (Reply |
| 970 | (Repeat instances "The number of instances that follow." |
| 971 | (tagged-object instance "An instance of this reference type.") |
| 972 | ) |
| 973 | ) |
| 974 | (ErrorSet |
| 975 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 976 | "type.") |
| 977 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 978 | (Error ILLEGAL_ARGUMENT "maxInstances is less than zero.") |
| 979 | (Error NOT_IMPLEMENTED) |
| 980 | (Error VM_DEAD) |
| 981 | ) |
| 982 | ) |
| 983 | (Command ClassFileVersion=17 |
| 984 | "Returns the class file major and minor version numbers, as defined in the class " |
| 985 | "file format of the Java Virtual Machine specification. " |
| 986 | "<p>Since JDWP version 1.6. " |
| 987 | (Out |
| 988 | (referenceType refType "The class.") |
| 989 | ) |
| 990 | (Reply |
| 991 | (int majorVersion "Major version number") |
| 992 | (int minorVersion "Minor version number") |
| 993 | ) |
| 994 | (ErrorSet |
| 995 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 996 | "type.") |
| 997 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 998 | (Error ABSENT_INFORMATION "The class file version information is " |
| 999 | "absent for primitive and array types.") |
| 1000 | (Error VM_DEAD) |
| 1001 | ) |
| 1002 | ) |
| 1003 | (Command ConstantPool=18 |
| 1004 | "Return the raw bytes of the constant pool in the format of the " |
| 1005 | "constant_pool item of the Class File Format in " |
| 1006 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 1007 | "<p>Since JDWP version 1.6. Requires canGetConstantPool capability - see " |
| 1008 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>."" |
| 1009 | (Out |
| 1010 | (referenceType refType "The class.") |
| 1011 | ) |
| 1012 | (Reply |
| 1013 | (int count "Total number of constant pool entries plus one. This " |
| 1014 | "corresponds to the constant_pool_count item of the " |
| 1015 | "Class File Format in " |
| 1016 | "<cite>The Java™ Virtual Machine Specification</cite>. ") |
| 1017 | (Repeat bytes |
| 1018 | (byte cpbytes "Raw bytes of constant pool") |
| 1019 | ) |
| 1020 | ) |
| 1021 | (ErrorSet |
| 1022 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1023 | "type.") |
| 1024 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1025 | (Error NOT_IMPLEMENTED "If the target virtual machine does not " |
| 1026 | "support the retrieval of constant pool information.") |
| 1027 | (Error ABSENT_INFORMATION "The Constant Pool information is " |
| 1028 | "absent for primitive and array types.") |
| 1029 | (Error VM_DEAD) |
| 1030 | ) |
| 1031 | ) |
| 1032 | ) |
| 1033 | (CommandSet ClassType=3 |
| 1034 | (Command Superclass=1 |
| 1035 | "Returns the immediate superclass of a class." |
| 1036 | (Out |
| 1037 | (classType clazz "The class type ID.") |
| 1038 | ) |
| 1039 | (Reply |
| 1040 | (classType superclass |
| 1041 | "The superclass (null if the class ID for java.lang.Object is specified).") |
| 1042 | ) |
| 1043 | (ErrorSet |
| 1044 | (Error INVALID_CLASS "clazz is not the ID of a class.") |
| 1045 | (Error INVALID_OBJECT "clazz is not a known ID.") |
| 1046 | (Error VM_DEAD) |
| 1047 | ) |
| 1048 | ) |
| 1049 | (Command SetValues=2 |
| 1050 | "Sets the value of one or more static fields. " |
| 1051 | "Each field must be member of the class type " |
| 1052 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 1053 | "Access control is not enforced; for example, the values of private " |
| 1054 | "fields can be set. Final fields cannot be set." |
| 1055 | "For primitive values, the value's type must match the " |
| 1056 | "field's type exactly. For object values, there must exist a " |
| 1057 | "widening reference conversion from the value's type to the |
| 1058 | "field's type and the field's type must be loaded. " |
| 1059 | (Out |
| 1060 | (classType clazz "The class type ID.") |
| 1061 | (Repeat values "The number of fields to set." |
| 1062 | (Group FieldValue "A Field/Value pair." |
| 1063 | (field fieldID "Field to set.") |
| 1064 | (untagged-value value "Value to put in the field.") |
| 1065 | ) |
| 1066 | ) |
| 1067 | ) |
| 1068 | (Reply "none" |
| 1069 | ) |
| 1070 | (ErrorSet |
| 1071 | (Error INVALID_CLASS "clazz is not the ID of a class.") |
| 1072 | (Error CLASS_NOT_PREPARED) |
| 1073 | (Error INVALID_OBJECT "clazz is not a known ID or a value of an " |
| 1074 | "object field is not a known ID.") |
| 1075 | (Error INVALID_FIELDID) |
| 1076 | (Error VM_DEAD) |
| 1077 | ) |
| 1078 | ) |
| 1079 | (Command InvokeMethod=3 |
| 1080 | "Invokes a static method. " |
| 1081 | "The method must be member of the class type " |
| 1082 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 1083 | "Access control is not enforced; for example, private " |
| 1084 | "methods can be invoked." |
| 1085 | "<p>" |
| 1086 | "The method invocation will occur in the specified thread. " |
| 1087 | "Method invocation can occur only if the specified thread " |
| 1088 | "has been suspended by an event. " |
| 1089 | "Method invocation is not supported " |
| 1090 | "when the target VM has been suspended by the front-end. " |
| 1091 | "<p>" |
| 1092 | "The specified method is invoked with the arguments in the specified " |
| 1093 | "argument list. " |
| 1094 | "The method invocation is synchronous; the reply packet is not " |
| 1095 | "sent until the invoked method returns in the target VM. " |
| 1096 | "The return value (possibly the void value) is " |
| 1097 | "included in the reply packet. " |
| 1098 | "If the invoked method throws an exception, the " |
| 1099 | "exception object ID is set in the reply packet; otherwise, the " |
| 1100 | "exception object ID is null. " |
| 1101 | "<p>" |
| 1102 | "For primitive arguments, the argument value's type must match the " |
| 1103 | "argument's type exactly. For object arguments, there must exist a " |
| 1104 | "widening reference conversion from the argument value's type to the " |
| 1105 | "argument's type and the argument's type must be loaded. " |
| 1106 | "<p>" |
| 1107 | "By default, all threads in the target VM are resumed while " |
| 1108 | "the method is being invoked if they were previously " |
| 1109 | "suspended by an event or by command. " |
| 1110 | "This is done to prevent the deadlocks " |
| 1111 | "that will occur if any of the threads own monitors " |
| 1112 | "that will be needed by the invoked method. It is possible that " |
| 1113 | "breakpoints or other events might occur during the invocation. " |
| 1114 | "Note, however, that this implicit resume acts exactly like " |
| 1115 | "the ThreadReference resume command, so if the thread's suspend " |
| 1116 | "count is greater than 1, it will remain in a suspended state " |
| 1117 | "during the invocation. By default, when the invocation completes, " |
| 1118 | "all threads in the target VM are suspended, regardless their state " |
| 1119 | "before the invocation. " |
| 1120 | "<p>" |
| 1121 | "The resumption of other threads during the invoke can be prevented " |
| 1122 | "by specifying the INVOKE_SINGLE_THREADED " |
| 1123 | "bit flag in the <code>options</code> field; however, " |
| 1124 | "there is no protection against or recovery from the deadlocks " |
| 1125 | "described above, so this option should be used with great caution. " |
| 1126 | "Only the specified thread will be resumed (as described for all " |
| 1127 | "threads above). Upon completion of a single threaded invoke, the invoking thread " |
| 1128 | "will be suspended once again. Note that any threads started during " |
| 1129 | "the single threaded invocation will not be suspended when the " |
| 1130 | "invocation completes. " |
| 1131 | "<p>" |
| 1132 | "If the target VM is disconnected during the invoke (for example, through " |
| 1133 | "the VirtualMachine dispose command) the method invocation continues. " |
| 1134 | (Out |
| 1135 | (classType clazz "The class type ID.") |
| 1136 | (threadObject thread "The thread in which to invoke.") |
| 1137 | (method methodID "The method to invoke.") |
| 1138 | (Repeat arguments |
| 1139 | (value arg "The argument value.") |
| 1140 | ) |
| 1141 | (int options "Invocation <a href=\"#JDWP_InvokeOptions\">options</a>") |
| 1142 | ) |
| 1143 | (Reply |
| 1144 | (value returnValue "The returned value.") |
| 1145 | (tagged-object exception "The thrown exception.") |
| 1146 | ) |
| 1147 | (ErrorSet |
| 1148 | (Error INVALID_CLASS "clazz is not the ID of a class.") |
| 1149 | (Error INVALID_OBJECT "clazz is not a known ID.") |
| 1150 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1151 | (Error INVALID_THREAD) |
| 1152 | (Error THREAD_NOT_SUSPENDED) |
| 1153 | (Error VM_DEAD) |
| 1154 | ) |
| 1155 | ) |
| 1156 | (Command NewInstance=4 |
| 1157 | "Creates a new object of this type, invoking the specified " |
| 1158 | "constructor. The constructor method ID must be a member of " |
| 1159 | "the class type." |
| 1160 | "<p>" |
| 1161 | "Instance creation will occur in the specified thread. " |
| 1162 | "Instance creation can occur only if the specified thread " |
| 1163 | "has been suspended by an event. " |
| 1164 | "Method invocation is not supported " |
| 1165 | "when the target VM has been suspended by the front-end. " |
| 1166 | "<p>" |
| 1167 | "The specified constructor is invoked with the arguments in the specified " |
| 1168 | "argument list. " |
| 1169 | "The constructor invocation is synchronous; the reply packet is not " |
| 1170 | "sent until the invoked method returns in the target VM. " |
| 1171 | "The return value (possibly the void value) is " |
| 1172 | "included in the reply packet. " |
| 1173 | "If the constructor throws an exception, the " |
| 1174 | "exception object ID is set in the reply packet; otherwise, the " |
| 1175 | "exception object ID is null. " |
| 1176 | "<p>" |
| 1177 | "For primitive arguments, the argument value's type must match the " |
| 1178 | "argument's type exactly. For object arguments, there must exist a " |
| 1179 | "widening reference conversion from the argument value's type to the " |
| 1180 | "argument's type and the argument's type must be loaded. " |
| 1181 | "<p>" |
| 1182 | "By default, all threads in the target VM are resumed while " |
| 1183 | "the method is being invoked if they were previously " |
| 1184 | "suspended by an event or by command. " |
| 1185 | "This is done to prevent the deadlocks " |
| 1186 | "that will occur if any of the threads own monitors " |
| 1187 | "that will be needed by the invoked method. It is possible that " |
| 1188 | "breakpoints or other events might occur during the invocation. " |
| 1189 | "Note, however, that this implicit resume acts exactly like " |
| 1190 | "the ThreadReference resume command, so if the thread's suspend " |
| 1191 | "count is greater than 1, it will remain in a suspended state " |
| 1192 | "during the invocation. By default, when the invocation completes, " |
| 1193 | "all threads in the target VM are suspended, regardless their state " |
| 1194 | "before the invocation. " |
| 1195 | "<p>" |
| 1196 | "The resumption of other threads during the invoke can be prevented " |
| 1197 | "by specifying the INVOKE_SINGLE_THREADED " |
| 1198 | "bit flag in the <code>options</code> field; however, " |
| 1199 | "there is no protection against or recovery from the deadlocks " |
| 1200 | "described above, so this option should be used with great caution. " |
| 1201 | "Only the specified thread will be resumed (as described for all " |
| 1202 | "threads above). Upon completion of a single threaded invoke, the invoking thread " |
| 1203 | "will be suspended once again. Note that any threads started during " |
| 1204 | "the single threaded invocation will not be suspended when the " |
| 1205 | "invocation completes. " |
| 1206 | "<p>" |
| 1207 | "If the target VM is disconnected during the invoke (for example, through " |
| 1208 | "the VirtualMachine dispose command) the method invocation continues. " |
| 1209 | (Out |
| 1210 | (classType clazz "The class type ID.") |
| 1211 | (threadObject thread "The thread in which to invoke the constructor.") |
| 1212 | (method methodID "The constructor to invoke.") |
| 1213 | (Repeat arguments |
| 1214 | (value arg "The argument value.") |
| 1215 | ) |
| 1216 | (int options "Constructor invocation <a href=\"#JDWP_InvokeOptions\">options</a>") |
| 1217 | ) |
| 1218 | (Reply |
| 1219 | (tagged-object newObject "The newly created object, or null " |
| 1220 | "if the constructor threw an exception.") |
| 1221 | (tagged-object exception "The thrown exception, if any; otherwise, null.") |
| 1222 | ) |
| 1223 | (ErrorSet |
| 1224 | (Error INVALID_CLASS "clazz is not the ID of a class.") |
| 1225 | (Error INVALID_OBJECT "clazz is not a known ID or a value of an " |
| 1226 | "object parameter is not a known ID..") |
| 1227 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1228 | (Error INVALID_OBJECT) |
| 1229 | (Error INVALID_THREAD) |
| 1230 | (Error THREAD_NOT_SUSPENDED) |
| 1231 | (Error VM_DEAD) |
| 1232 | ) |
| 1233 | ) |
| 1234 | ) |
| 1235 | (CommandSet ArrayType=4 |
| 1236 | (Command NewInstance=1 |
| 1237 | "Creates a new array object of this type with a given length." |
| 1238 | (Out |
| 1239 | (arrayType arrType "The array type of the new instance.") |
| 1240 | (int length "The length of the array.") |
| 1241 | ) |
| 1242 | (Reply |
| 1243 | (tagged-object newArray "The newly created array object. ") |
| 1244 | ) |
| 1245 | (ErrorSet |
| 1246 | (Error INVALID_ARRAY) |
| 1247 | (Error INVALID_OBJECT) |
| 1248 | (Error VM_DEAD) |
| 1249 | ) |
| 1250 | ) |
| 1251 | ) |
| 1252 | (CommandSet InterfaceType=5 |
| 1253 | ) |
| 1254 | (CommandSet Method=6 |
| 1255 | (Command LineTable=1 |
| 1256 | "Returns line number information for the method, if present. " |
| 1257 | "The line table maps source line numbers to the initial code index " |
| 1258 | "of the line. The line table " |
| 1259 | "is ordered by code index (from lowest to highest). The line number " |
| 1260 | "information is constant unless a new class definition is installed " |
| 1261 | "using <a href=\"#JDWP_VirtualMachine_RedefineClasses\">RedefineClasses</a>." |
| 1262 | (Out |
| 1263 | (referenceType refType "The class.") |
| 1264 | (method methodID "The method.") |
| 1265 | ) |
| 1266 | (Reply |
| 1267 | (long start "Lowest valid code index for the method, >=0, or -1 if the method is native ") |
| 1268 | (long end "Highest valid code index for the method, >=0, or -1 if the method is native") |
| 1269 | (Repeat lines "The number of entries in the line table for this method." |
| 1270 | (Group LineInfo |
| 1271 | (long lineCodeIndex "Initial code index of the line, " |
| 1272 | "start <= lineCodeIndex < end") |
| 1273 | (int lineNumber "Line number.") |
| 1274 | ) |
| 1275 | ) |
| 1276 | ) |
| 1277 | (ErrorSet |
| 1278 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1279 | "type.") |
| 1280 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1281 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1282 | (Error VM_DEAD) |
| 1283 | ) |
| 1284 | ) |
| 1285 | (Command VariableTable=2 |
| 1286 | "Returns variable information for the method. The variable table " |
| 1287 | "includes arguments and locals declared within the method. For " |
| 1288 | "instance methods, the \"this\" reference is included in the " |
| 1289 | "table. Also, synthetic variables may be present. " |
| 1290 | (Out |
| 1291 | (referenceType refType "The class.") |
| 1292 | (method methodID "The method.") |
| 1293 | ) |
| 1294 | (Reply |
| 1295 | (int argCnt "The number of words in the frame used by arguments. " |
| 1296 | "Eight-byte arguments use two words; all others use one. ") |
| 1297 | (Repeat slots "The number of variables." |
| 1298 | (Group SlotInfo "Information about the variable." |
| 1299 | (long codeIndex |
| 1300 | "First code index at which the variable is visible (unsigned). " |
| 1301 | "Used in conjunction with <code>length</code>. " |
| 1302 | "The variable can be get or set only when the current " |
| 1303 | "<code>codeIndex</code> <= current frame code index < <code>codeIndex + length</code> ") |
| 1304 | (string name "The variable's name.") |
| 1305 | (string signature "The variable type's JNI signature.") |
| 1306 | (int length |
| 1307 | "Unsigned value used in conjunction with <code>codeIndex</code>. " |
| 1308 | "The variable can be get or set only when the current " |
| 1309 | "<code>codeIndex</code> <= current frame code index < <code>code index + length</code> ") |
| 1310 | (int slot "The local variable's index in its frame") |
| 1311 | ) |
| 1312 | ) |
| 1313 | ) |
| 1314 | (ErrorSet |
| 1315 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1316 | "type.") |
| 1317 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1318 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1319 | (Error ABSENT_INFORMATION "there is no variable information for the method.") |
| 1320 | (Error VM_DEAD) |
| 1321 | ) |
| 1322 | ) |
| 1323 | (Command Bytecodes=3 |
| 1324 | "Retrieve the method's bytecodes as defined in " |
| 1325 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 1326 | "Requires canGetBytecodes capability - see " |
| 1327 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 1328 | (Out |
| 1329 | (referenceType refType "The class.") |
| 1330 | (method methodID "The method.") |
| 1331 | ) |
| 1332 | (Reply |
| 1333 | (Repeat bytes |
| 1334 | (byte bytecode "A Java bytecode.") |
| 1335 | ) |
| 1336 | ) |
| 1337 | (ErrorSet |
| 1338 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1339 | "type.") |
| 1340 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1341 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1342 | (Error NOT_IMPLEMENTED "If the target virtual machine does not " |
| 1343 | "support the retrieval of bytecodes.") |
| 1344 | (Error VM_DEAD) |
| 1345 | ) |
| 1346 | ) |
| 1347 | (Command IsObsolete=4 |
| 1348 | "Determine if this method is obsolete. A method is obsolete if it has been replaced " |
| 1349 | "by a non-equivalent method using the " |
| 1350 | "<a href=\"#JDWP_VirtualMachine_RedefineClasses\">RedefineClasses</a> command. " |
| 1351 | "The original and redefined methods are considered equivalent if their bytecodes are " |
| 1352 | "the same except for indices into the constant pool and the referenced constants are " |
| 1353 | "equal." |
| 1354 | (Out |
| 1355 | (referenceType refType "The class.") |
| 1356 | (method methodID "The method.") |
| 1357 | ) |
| 1358 | (Reply |
| 1359 | (boolean isObsolete "true if this method has been replaced" |
| 1360 | "by a non-equivalent method using" |
| 1361 | "the RedefineClasses command.") |
| 1362 | ) |
| 1363 | (ErrorSet |
| 1364 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1365 | "type.") |
| 1366 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1367 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1368 | (Error NOT_IMPLEMENTED "If the target virtual machine does " |
| 1369 | "not support this query.") |
| 1370 | (Error VM_DEAD) |
| 1371 | ) |
| 1372 | ) |
| 1373 | (Command VariableTableWithGeneric=5 |
| 1374 | "Returns variable information for the method, including " |
| 1375 | "generic signatures for the variables. The variable table " |
| 1376 | "includes arguments and locals declared within the method. For " |
| 1377 | "instance methods, the \"this\" reference is included in the " |
| 1378 | "table. Also, synthetic variables may be present. " |
| 1379 | "Generic signatures are described in the signature attribute " |
| 1380 | "section in " |
| 1381 | "<cite>The Java™ Virtual Machine Specification</cite>. " |
| 1382 | "Since JDWP version 1.5." |
| 1383 | (Out |
| 1384 | (referenceType refType "The class.") |
| 1385 | (method methodID "The method.") |
| 1386 | ) |
| 1387 | (Reply |
| 1388 | (int argCnt "The number of words in the frame used by arguments. " |
| 1389 | "Eight-byte arguments use two words; all others use one. ") |
| 1390 | (Repeat slots "The number of variables." |
| 1391 | (Group SlotInfo "Information about the variable." |
| 1392 | (long codeIndex |
| 1393 | "First code index at which the variable is visible (unsigned). " |
| 1394 | "Used in conjunction with <code>length</code>. " |
| 1395 | "The variable can be get or set only when the current " |
| 1396 | "<code>codeIndex</code> <= current frame code index < <code>codeIndex + length</code> ") |
| 1397 | (string name "The variable's name.") |
| 1398 | (string signature "The variable type's JNI signature.") |
| 1399 | (string genericSignature "The variable type's generic " |
| 1400 | "signature or an empty string if there is none.") |
| 1401 | (int length |
| 1402 | "Unsigned value used in conjunction with <code>codeIndex</code>. " |
| 1403 | "The variable can be get or set only when the current " |
| 1404 | "<code>codeIndex</code> <= current frame code index < <code>code index + length</code> ") |
| 1405 | (int slot "The local variable's index in its frame") |
| 1406 | ) |
| 1407 | ) |
| 1408 | ) |
| 1409 | (ErrorSet |
| 1410 | (Error INVALID_CLASS "refType is not the ID of a reference " |
| 1411 | "type.") |
| 1412 | (Error INVALID_OBJECT "refType is not a known ID.") |
| 1413 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1414 | (Error ABSENT_INFORMATION "there is no variable information for the method.") |
| 1415 | (Error VM_DEAD) |
| 1416 | ) |
| 1417 | ) |
| 1418 | |
| 1419 | ) |
| 1420 | (CommandSet Field=8 |
| 1421 | ) |
| 1422 | (CommandSet ObjectReference=9 |
| 1423 | (Command ReferenceType=1 |
| 1424 | "Returns the runtime type of the object. " |
| 1425 | "The runtime type will be a class or an array. " |
| 1426 | (Out |
| 1427 | (object object "The object ID") |
| 1428 | ) |
| 1429 | (Reply |
| 1430 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 1431 | "of following reference type. ") |
| 1432 | (referenceTypeID typeID "The runtime reference type.") |
| 1433 | ) |
| 1434 | (ErrorSet |
| 1435 | (Error INVALID_OBJECT) |
| 1436 | (Error VM_DEAD) |
| 1437 | ) |
| 1438 | ) |
| 1439 | (Command GetValues=2 |
| 1440 | "Returns the value of one or more instance fields. " |
| 1441 | "Each field must be member of the object's type " |
| 1442 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 1443 | "Access control is not enforced; for example, the values of private " |
| 1444 | "fields can be obtained." |
| 1445 | (Out |
| 1446 | (object object "The object ID") |
| 1447 | (Repeat fields "The number of values to get" |
| 1448 | (Group Field |
| 1449 | (field fieldID "Field to get.") |
| 1450 | ) |
| 1451 | ) |
| 1452 | ) |
| 1453 | (Reply |
| 1454 | (Repeat values "The number of values returned, always equal to 'fields', " |
| 1455 | "the number of values to get. Field values are ordered " |
| 1456 | "in the reply in the same order as corresponding fieldIDs " |
| 1457 | "in the command." |
| 1458 | (value value "The field value") |
| 1459 | ) |
| 1460 | ) |
| 1461 | (ErrorSet |
| 1462 | (Error INVALID_OBJECT) |
| 1463 | (Error INVALID_FIELDID) |
| 1464 | (Error VM_DEAD) |
| 1465 | ) |
| 1466 | ) |
| 1467 | (Command SetValues=3 |
| 1468 | "Sets the value of one or more instance fields. " |
| 1469 | "Each field must be member of the object's type " |
| 1470 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 1471 | "Access control is not enforced; for example, the values of private " |
| 1472 | "fields can be set. " |
| 1473 | "For primitive values, the value's type must match the " |
| 1474 | "field's type exactly. For object values, there must be a " |
| 1475 | "widening reference conversion from the value's type to the |
| 1476 | "field's type and the field's type must be loaded. " |
| 1477 | (Out |
| 1478 | (object object "The object ID") |
| 1479 | (Repeat values "The number of fields to set." |
| 1480 | (Group FieldValue "A Field/Value pair." |
| 1481 | (field fieldID "Field to set.") |
| 1482 | (untagged-value value "Value to put in the field.") |
| 1483 | ) |
| 1484 | ) |
| 1485 | ) |
| 1486 | (Reply "none" |
| 1487 | ) |
| 1488 | (ErrorSet |
| 1489 | (Error INVALID_OBJECT) |
| 1490 | (Error INVALID_FIELDID) |
| 1491 | (Error VM_DEAD) |
| 1492 | ) |
| 1493 | ) |
| 1494 | (Command MonitorInfo=5 |
| 1495 | "Returns monitor information for an object. All threads int the VM must " |
| 1496 | "be suspended." |
| 1497 | "Requires canGetMonitorInfo capability - see " |
| 1498 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 1499 | (Out |
| 1500 | (object object "The object ID") |
| 1501 | ) |
| 1502 | (Reply |
| 1503 | (threadObject owner "The monitor owner, or null if it is not currently owned.") |
| 1504 | (int entryCount "The number of times the monitor has been entered.") |
| 1505 | (Repeat waiters "The number of threads that are waiting for the monitor " |
| 1506 | "0 if there is no current owner" |
| 1507 | (threadObject thread "A thread waiting for this monitor.") |
| 1508 | ) |
| 1509 | ) |
| 1510 | (ErrorSet |
| 1511 | (Error INVALID_OBJECT) |
| 1512 | (Error NOT_IMPLEMENTED) |
| 1513 | (Error VM_DEAD) |
| 1514 | ) |
| 1515 | ) |
| 1516 | (Command InvokeMethod=6 |
| 1517 | "Invokes a instance method. " |
| 1518 | "The method must be member of the object's type " |
| 1519 | "or one of its superclasses, superinterfaces, or implemented interfaces. " |
| 1520 | "Access control is not enforced; for example, private " |
| 1521 | "methods can be invoked." |
| 1522 | "<p>" |
| 1523 | "The method invocation will occur in the specified thread. " |
| 1524 | "Method invocation can occur only if the specified thread " |
| 1525 | "has been suspended by an event. " |
| 1526 | "Method invocation is not supported " |
| 1527 | "when the target VM has been suspended by the front-end. " |
| 1528 | "<p>" |
| 1529 | "The specified method is invoked with the arguments in the specified " |
| 1530 | "argument list. " |
| 1531 | "The method invocation is synchronous; the reply packet is not " |
| 1532 | "sent until the invoked method returns in the target VM. " |
| 1533 | "The return value (possibly the void value) is " |
| 1534 | "included in the reply packet. " |
| 1535 | "If the invoked method throws an exception, the " |
| 1536 | "exception object ID is set in the reply packet; otherwise, the " |
| 1537 | "exception object ID is null. " |
| 1538 | "<p>" |
| 1539 | "For primitive arguments, the argument value's type must match the " |
| 1540 | "argument's type exactly. For object arguments, there must be a " |
| 1541 | "widening reference conversion from the argument value's type to the " |
| 1542 | "argument's type and the argument's type must be loaded. " |
| 1543 | "<p>" |
| 1544 | "By default, all threads in the target VM are resumed while " |
| 1545 | "the method is being invoked if they were previously " |
| 1546 | "suspended by an event or by command. " |
| 1547 | "This is done to prevent the deadlocks " |
| 1548 | "that will occur if any of the threads own monitors " |
| 1549 | "that will be needed by the invoked method. It is possible that " |
| 1550 | "breakpoints or other events might occur during the invocation. " |
| 1551 | "Note, however, that this implicit resume acts exactly like " |
| 1552 | "the ThreadReference resume command, so if the thread's suspend " |
| 1553 | "count is greater than 1, it will remain in a suspended state " |
| 1554 | "during the invocation. By default, when the invocation completes, " |
| 1555 | "all threads in the target VM are suspended, regardless their state " |
| 1556 | "before the invocation. " |
| 1557 | "<p>" |
| 1558 | "The resumption of other threads during the invoke can be prevented " |
| 1559 | "by specifying the INVOKE_SINGLE_THREADED " |
| 1560 | "bit flag in the <code>options</code> field; however, " |
| 1561 | "there is no protection against or recovery from the deadlocks " |
| 1562 | "described above, so this option should be used with great caution. " |
| 1563 | "Only the specified thread will be resumed (as described for all " |
| 1564 | "threads above). Upon completion of a single threaded invoke, the invoking thread " |
| 1565 | "will be suspended once again. Note that any threads started during " |
| 1566 | "the single threaded invocation will not be suspended when the " |
| 1567 | "invocation completes. " |
| 1568 | "<p>" |
| 1569 | "If the target VM is disconnected during the invoke (for example, through " |
| 1570 | "the VirtualMachine dispose command) the method invocation continues. " |
| 1571 | (Out |
| 1572 | (object object "The object ID") |
| 1573 | (threadObject thread "The thread in which to invoke.") |
| 1574 | (classType clazz "The class type.") |
| 1575 | (method methodID "The method to invoke.") |
| 1576 | (Repeat arguments "The number of arguments." |
| 1577 | (value arg "The argument value.") |
| 1578 | ) |
| 1579 | (int options "Invocation <a href=\"#JDWP_InvokeOptions\">options</a>") |
| 1580 | ) |
| 1581 | (Reply |
| 1582 | (value returnValue "The returned value, or null if an exception is thrown.") |
| 1583 | (tagged-object exception "The thrown exception, if any.") |
| 1584 | ) |
| 1585 | (ErrorSet |
| 1586 | (Error INVALID_OBJECT) |
| 1587 | (Error INVALID_CLASS "clazz is not the ID of a reference " |
| 1588 | "type.") |
| 1589 | (Error INVALID_METHODID "methodID is not the ID of a method.") |
| 1590 | (Error INVALID_THREAD) |
| 1591 | (Error THREAD_NOT_SUSPENDED) |
| 1592 | (Error VM_DEAD) |
| 1593 | ) |
| 1594 | ) |
| 1595 | (Command DisableCollection=7 |
| 1596 | "Prevents garbage collection for the given object. By " |
| 1597 | "default all objects in back-end replies may be " |
| 1598 | "collected at any time the target VM is running. A call to " |
| 1599 | "this command guarantees that the object will not be " |
| 1600 | "collected. The " |
| 1601 | "<a href=\"#JDWP_ObjectReference_EnableCollection\">EnableCollection</a> " |
| 1602 | "command can be used to " |
| 1603 | "allow collection once again. " |
| 1604 | "<p>" |
| 1605 | "Note that while the target VM is suspended, no garbage " |
| 1606 | "collection will occur because all threads are suspended. " |
| 1607 | "The typical examination of variables, fields, and arrays " |
| 1608 | "during the suspension is safe without explicitly disabling " |
| 1609 | "garbage collection. " |
| 1610 | "<p>" |
| 1611 | "This method should be used sparingly, as it alters the " |
| 1612 | "pattern of garbage collection in the target VM and, " |
| 1613 | "consequently, may result in application behavior under the " |
| 1614 | "debugger that differs from its non-debugged behavior. " |
| 1615 | (Out |
| 1616 | (object object "The object ID") |
| 1617 | ) |
| 1618 | (Reply "none" |
| 1619 | ) |
| 1620 | (ErrorSet |
| 1621 | (Error INVALID_OBJECT) |
| 1622 | (Error VM_DEAD) |
| 1623 | ) |
| 1624 | ) |
| 1625 | (Command EnableCollection=8 |
| 1626 | "Permits garbage collection for this object. By default all " |
| 1627 | "objects returned by JDWP may become unreachable in the target VM, " |
| 1628 | "and hence may be garbage collected. A call to this command is " |
| 1629 | "necessary only if garbage collection was previously disabled with " |
| 1630 | "the <a href=\"#JDWP_ObjectReference_DisableCollection\">DisableCollection</a> " |
| 1631 | "command." |
| 1632 | (Out |
| 1633 | (object object "The object ID") |
| 1634 | ) |
| 1635 | (Reply "none" |
| 1636 | ) |
| 1637 | (ErrorSet |
| 1638 | (Error VM_DEAD) |
| 1639 | ) |
| 1640 | ) |
| 1641 | (Command IsCollected=9 |
| 1642 | "Determines whether an object has been garbage collected in the " |
| 1643 | "target VM. " |
| 1644 | (Out |
| 1645 | (object object "The object ID") |
| 1646 | ) |
| 1647 | (Reply |
| 1648 | (boolean isCollected "true if the object has been collected; false otherwise") |
| 1649 | ) |
| 1650 | (ErrorSet |
| 1651 | (Error INVALID_OBJECT) |
| 1652 | (Error VM_DEAD) |
| 1653 | ) |
| 1654 | ) |
| 1655 | (Command ReferringObjects=10 |
| 1656 | "Returns objects that directly reference this object. " |
| 1657 | "Only objects that are reachable for the purposes " |
| 1658 | "of garbage collection are returned. " |
| 1659 | "Note that an object can also be referenced in other ways, " |
| 1660 | "such as from a local variable in a stack frame, or from a JNI global " |
| 1661 | "reference. Such non-object referrers are not returned by this command. " |
| 1662 | "<p>Since JDWP version 1.6. Requires canGetInstanceInfo capability - see " |
| 1663 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 1664 | (Out |
| 1665 | (object object "The object ID") |
| 1666 | (int maxReferrers "Maximum number of referring objects to return. " |
| 1667 | "Must be non-negative. If zero, all referring " |
| 1668 | "objects are returned.") |
| 1669 | ) |
| 1670 | (Reply |
| 1671 | (Repeat referringObjects "The number of objects that follow." |
| 1672 | (tagged-object instance "An object that references this object.") |
| 1673 | ) |
| 1674 | ) |
| 1675 | (ErrorSet |
| 1676 | (Error INVALID_OBJECT "object is not a known ID.") |
| 1677 | (Error ILLEGAL_ARGUMENT "maxReferrers is less than zero.") |
| 1678 | (Error NOT_IMPLEMENTED) |
| 1679 | (Error VM_DEAD) |
| 1680 | ) |
| 1681 | ) |
| 1682 | ) |
| 1683 | |
| 1684 | (CommandSet StringReference=10 |
| 1685 | (Command Value=1 |
| 1686 | "Returns the characters contained in the string. " |
| 1687 | (Out |
| 1688 | (object stringObject "The String object ID. ") |
| 1689 | ) |
| 1690 | (Reply |
| 1691 | (string stringValue "UTF-8 representation of the string value.") |
| 1692 | ) |
| 1693 | (ErrorSet |
| 1694 | (Error INVALID_STRING) |
| 1695 | (Error INVALID_OBJECT) |
| 1696 | (Error VM_DEAD) |
| 1697 | ) |
| 1698 | ) |
| 1699 | ) |
| 1700 | (CommandSet ThreadReference=11 |
| 1701 | (Command Name=1 |
| 1702 | "Returns the thread name. " |
| 1703 | (Out |
| 1704 | (threadObject thread "The thread object ID. ") |
| 1705 | ) |
| 1706 | (Reply |
| 1707 | (string threadName "The thread name.") |
| 1708 | ) |
| 1709 | (ErrorSet |
| 1710 | (Error INVALID_THREAD) |
| 1711 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1712 | (Error VM_DEAD) |
| 1713 | ) |
| 1714 | ) |
| 1715 | (Command Suspend=2 |
| 1716 | "Suspends the thread. " |
| 1717 | "<p>" |
| 1718 | "Unlike java.lang.Thread.suspend(), suspends of both " |
| 1719 | "the virtual machine and individual threads are counted. Before " |
| 1720 | "a thread will run again, it must be resumed the same number " |
| 1721 | "of times it has been suspended. " |
| 1722 | "<p>" |
| 1723 | "Suspending single threads with command has the same " |
| 1724 | "dangers java.lang.Thread.suspend(). If the suspended " |
| 1725 | "thread holds a monitor needed by another running thread, " |
| 1726 | "deadlock is possible in the target VM (at least until the " |
| 1727 | "suspended thread is resumed again). " |
| 1728 | "<p>" |
| 1729 | "The suspended thread is guaranteed to remain suspended until " |
| 1730 | "resumed through one of the JDI resume methods mentioned above; " |
| 1731 | "the application in the target VM cannot resume the suspended thread " |
| 1732 | "through {@link java.lang.Thread#resume}. " |
| 1733 | "<p>" |
| 1734 | "Note that this doesn't change the status of the thread (see the " |
| 1735 | "<a href=\"#JDWP_ThreadReference_Status\">ThreadStatus</a> command.) " |
| 1736 | "For example, if it was " |
| 1737 | "Running, it will still appear running to other threads. " |
| 1738 | (Out |
| 1739 | (threadObject thread "The thread object ID. ") |
| 1740 | ) |
| 1741 | (Reply "none" |
| 1742 | ) |
| 1743 | (ErrorSet |
| 1744 | (Error INVALID_THREAD) |
| 1745 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1746 | (Error VM_DEAD) |
| 1747 | ) |
| 1748 | ) |
| 1749 | (Command Resume=3 |
| 1750 | "Resumes the execution of a given thread. If this thread was " |
| 1751 | "not previously suspended by the front-end, " |
| 1752 | "calling this command has no effect. " |
| 1753 | "Otherwise, the count of pending suspends on this thread is " |
| 1754 | "decremented. If it is decremented to 0, the thread will " |
| 1755 | "continue to execute. " |
| 1756 | (Out |
| 1757 | (threadObject thread "The thread object ID. ") |
| 1758 | ) |
| 1759 | (Reply "none" |
| 1760 | ) |
| 1761 | (ErrorSet |
| 1762 | (Error INVALID_THREAD) |
| 1763 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1764 | (Error VM_DEAD) |
| 1765 | ) |
| 1766 | ) |
| 1767 | (Command Status=4 |
| 1768 | "Returns the current status of a thread. The thread status " |
| 1769 | "reply indicates the thread status the last time it was running. " |
| 1770 | "the suspend status provides information on the thread's " |
| 1771 | "suspension, if any." |
| 1772 | (Out |
| 1773 | (threadObject thread "The thread object ID. ") |
| 1774 | ) |
| 1775 | (Reply |
| 1776 | (int threadStatus "One of the thread status codes " |
| 1777 | "See <a href=\"#JDWP_ThreadStatus\">JDWP.ThreadStatus</a>") |
| 1778 | (int suspendStatus "One of the suspend status codes " |
| 1779 | "See <a href=\"#JDWP_SuspendStatus\">JDWP.SuspendStatus</a>") |
| 1780 | ) |
| 1781 | (ErrorSet |
| 1782 | (Error INVALID_THREAD) |
| 1783 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1784 | (Error VM_DEAD) |
| 1785 | ) |
| 1786 | ) |
| 1787 | (Command ThreadGroup=5 |
| 1788 | "Returns the thread group that contains a given thread. " |
| 1789 | (Out |
| 1790 | (threadObject thread "The thread object ID. ") |
| 1791 | ) |
| 1792 | (Reply |
| 1793 | (threadGroupObject group "The thread group of this thread. ") |
| 1794 | ) |
| 1795 | (ErrorSet |
| 1796 | (Error INVALID_THREAD) |
| 1797 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1798 | (Error VM_DEAD) |
| 1799 | ) |
| 1800 | ) |
| 1801 | (Command Frames=6 |
| 1802 | "Returns the current call stack of a suspended thread. " |
| 1803 | "The sequence of frames starts with " |
| 1804 | "the currently executing frame, followed by its caller, " |
| 1805 | "and so on. The thread must be suspended, and the returned " |
| 1806 | "frameID is valid only while the thread is suspended. " |
| 1807 | (Out |
| 1808 | (threadObject thread "The thread object ID. ") |
| 1809 | (int startFrame "The index of the first frame to retrieve.") |
| 1810 | (int length |
| 1811 | "The count of frames to retrieve " |
| 1812 | "(-1 means all remaining). ") |
| 1813 | ) |
| 1814 | (Reply |
| 1815 | (Repeat frames "The number of frames retreived" |
| 1816 | (Group Frame |
| 1817 | (frame frameID "The ID of this frame. ") |
| 1818 | (location location "The current location of this frame") |
| 1819 | ) |
| 1820 | ) |
| 1821 | ) |
| 1822 | (ErrorSet |
| 1823 | (Error INVALID_THREAD) |
| 1824 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1825 | (Error VM_DEAD) |
| 1826 | ) |
| 1827 | ) |
| 1828 | (Command FrameCount=7 |
| 1829 | "Returns the count of frames on this thread's stack. " |
| 1830 | "The thread must be suspended, and the returned " |
| 1831 | "count is valid only while the thread is suspended. " |
| 1832 | "Returns JDWP.Error.errorThreadNotSuspended if not suspended. " |
| 1833 | (Out |
| 1834 | (threadObject thread "The thread object ID. ") |
| 1835 | ) |
| 1836 | (Reply |
| 1837 | (int frameCount "The count of frames on this thread's stack. ") |
| 1838 | ) |
| 1839 | (ErrorSet |
| 1840 | (Error INVALID_THREAD) |
| 1841 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1842 | (Error VM_DEAD) |
| 1843 | ) |
| 1844 | ) |
| 1845 | (Command OwnedMonitors=8 |
| 1846 | "Returns the objects whose monitors have been entered by this thread. " |
| 1847 | "The thread must be suspended, and the returned information is " |
| 1848 | "relevant only while the thread is suspended. " |
| 1849 | "Requires canGetOwnedMonitorInfo capability - see " |
| 1850 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 1851 | (Out |
| 1852 | (threadObject thread "The thread object ID. ") |
| 1853 | ) |
| 1854 | (Reply |
| 1855 | (Repeat owned "The number of owned monitors" |
| 1856 | (tagged-object monitor "An owned monitor") |
| 1857 | ) |
| 1858 | ) |
| 1859 | (ErrorSet |
| 1860 | (Error INVALID_THREAD) |
| 1861 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1862 | (Error NOT_IMPLEMENTED) |
| 1863 | (Error VM_DEAD) |
| 1864 | ) |
| 1865 | ) |
| 1866 | (Command CurrentContendedMonitor=9 |
| 1867 | "Returns the object, if any, for which this thread is waiting. The " |
| 1868 | "thread may be waiting to enter a monitor, or it may be waiting, via " |
| 1869 | "the java.lang.Object.wait method, for another thread to invoke the " |
| 1870 | "notify method. " |
| 1871 | "The thread must be suspended, and the returned information is " |
| 1872 | "relevant only while the thread is suspended. " |
| 1873 | "Requires canGetCurrentContendedMonitor capability - see " |
| 1874 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 1875 | (Out |
| 1876 | (threadObject thread "The thread object ID. ") |
| 1877 | ) |
| 1878 | (Reply |
| 1879 | (tagged-object monitor "The contended monitor, or null if " |
| 1880 | "there is no current contended monitor. ") |
| 1881 | ) |
| 1882 | (ErrorSet |
| 1883 | (Error INVALID_THREAD) |
| 1884 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1885 | (Error NOT_IMPLEMENTED) |
| 1886 | (Error VM_DEAD) |
| 1887 | ) |
| 1888 | ) |
| 1889 | (Command Stop=10 |
| 1890 | "Stops the thread with an asynchronous exception, as if done by " |
| 1891 | "java.lang.Thread.stop " |
| 1892 | (Out |
| 1893 | (threadObject thread "The thread object ID. ") |
| 1894 | (object throwable "Asynchronous exception. This object must " |
| 1895 | "be an instance of java.lang.Throwable or a subclass") |
| 1896 | ) |
| 1897 | (Reply "none" |
| 1898 | ) |
| 1899 | (ErrorSet |
| 1900 | (Error INVALID_THREAD) |
| 1901 | (Error INVALID_OBJECT "If thread is not a known ID or the asynchronous " |
| 1902 | "exception has been garbage collected.") |
| 1903 | (Error VM_DEAD) |
| 1904 | ) |
| 1905 | ) |
| 1906 | (Command Interrupt=11 |
| 1907 | "Interrupt the thread, as if done by java.lang.Thread.interrupt " |
| 1908 | (Out |
| 1909 | (threadObject thread "The thread object ID. ") |
| 1910 | ) |
| 1911 | (Reply "none" |
| 1912 | ) |
| 1913 | (ErrorSet |
| 1914 | (Error INVALID_THREAD) |
| 1915 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1916 | (Error VM_DEAD) |
| 1917 | ) |
| 1918 | ) |
| 1919 | (Command SuspendCount=12 |
| 1920 | "Get the suspend count for this thread. The suspend count is the " |
| 1921 | "number of times the thread has been suspended through the " |
| 1922 | "thread-level or VM-level suspend commands without a corresponding resume " |
| 1923 | (Out |
| 1924 | (threadObject thread "The thread object ID. ") |
| 1925 | ) |
| 1926 | (Reply |
| 1927 | (int suspendCount "The number of outstanding suspends of this thread. ") |
| 1928 | ) |
| 1929 | (ErrorSet |
| 1930 | (Error INVALID_THREAD) |
| 1931 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1932 | (Error VM_DEAD) |
| 1933 | ) |
| 1934 | ) |
| 1935 | (Command OwnedMonitorsStackDepthInfo=13 |
| 1936 | "Returns monitor objects owned by the thread, along with stack depth at which " |
| 1937 | "the monitor was acquired. Returns stack depth of -1 if " |
| 1938 | "the implementation cannot determine the stack depth " |
| 1939 | "(e.g., for monitors acquired by JNI MonitorEnter)." |
| 1940 | "The thread must be suspended, and the returned information is " |
| 1941 | "relevant only while the thread is suspended. " |
| 1942 | "Requires canGetMonitorFrameInfo capability - see " |
| 1943 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 1944 | "<p>Since JDWP version 1.6. " |
| 1945 | |
| 1946 | (Out |
| 1947 | (threadObject thread "The thread object ID. ") |
| 1948 | ) |
| 1949 | (Reply |
| 1950 | (Repeat owned "The number of owned monitors" |
| 1951 | (Group monitor |
| 1952 | (tagged-object monitor "An owned monitor") |
| 1953 | (int stack_depth "Stack depth location where monitor was acquired") |
| 1954 | ) |
| 1955 | ) |
| 1956 | ) |
| 1957 | (ErrorSet |
| 1958 | (Error INVALID_THREAD) |
| 1959 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 1960 | (Error NOT_IMPLEMENTED) |
| 1961 | (Error VM_DEAD) |
| 1962 | ) |
| 1963 | ) |
| 1964 | (Command ForceEarlyReturn=14 |
| 1965 | "Force a method to return before it reaches a return " |
| 1966 | "statement. " |
| 1967 | "<p>" |
| 1968 | "The method which will return early is referred to as the " |
| 1969 | "called method. The called method is the current method (as " |
| 1970 | "defined by the Frames section in " |
| 1971 | "<cite>The Java™ Virtual Machine Specification</cite>) " |
| 1972 | "for the specified thread at the time this command " |
| 1973 | "is received. " |
| 1974 | "<p>" |
| 1975 | "The specified thread must be suspended. " |
| 1976 | "The return occurs when execution of Java programming " |
| 1977 | "language code is resumed on this thread. Between sending this " |
| 1978 | "command and resumption of thread execution, the " |
| 1979 | "state of the stack is undefined. " |
| 1980 | "<p>" |
| 1981 | "No further instructions are executed in the called " |
| 1982 | "method. Specifically, finally blocks are not executed. Note: " |
| 1983 | "this can cause inconsistent states in the application. " |
| 1984 | "<p>" |
| 1985 | "A lock acquired by calling the called method (if it is a " |
| 1986 | "synchronized method) and locks acquired by entering " |
| 1987 | "synchronized blocks within the called method are " |
| 1988 | "released. Note: this does not apply to JNI locks or " |
| 1989 | "java.util.concurrent.locks locks. " |
| 1990 | "<p>" |
| 1991 | "Events, such as MethodExit, are generated as they would be in " |
| 1992 | "a normal return. " |
| 1993 | "<p>" |
| 1994 | "The called method must be a non-native Java programming " |
| 1995 | "language method. Forcing return on a thread with only one " |
| 1996 | "frame on the stack causes the thread to exit when resumed. " |
| 1997 | "<p>" |
| 1998 | "For void methods, the value must be a void value. " |
| 1999 | "For methods that return primitive values, the value's type must " |
| 2000 | "match the return type exactly. For object values, there must be a " |
| 2001 | "widening reference conversion from the value's type to the " |
| 2002 | "return type type and the return type must be loaded. " |
| 2003 | "<p>" |
| 2004 | "Since JDWP version 1.6. Requires canForceEarlyReturn capability - see " |
| 2005 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 2006 | (Out |
| 2007 | (threadObject thread "The thread object ID. ") |
| 2008 | (value value "The value to return. ") |
| 2009 | ) |
| 2010 | (Reply "none" |
| 2011 | ) |
| 2012 | (ErrorSet |
| 2013 | (Error INVALID_THREAD) |
| 2014 | (Error INVALID_OBJECT "Thread or value is not a known ID.") |
| 2015 | (Error THREAD_NOT_SUSPENDED) |
| 2016 | (Error THREAD_NOT_ALIVE) |
| 2017 | (Error OPAQUE_FRAME "Attempted to return early from " |
| 2018 | "a frame corresponding to a native " |
| 2019 | "method. Or the implementation is " |
| 2020 | "unable to provide this functionality " |
| 2021 | "on this frame.") |
| 2022 | (Error NO_MORE_FRAMES) |
| 2023 | (Error NOT_IMPLEMENTED) |
| 2024 | (Error TYPE_MISMATCH "Value is not an appropriate type for the " |
| 2025 | "return value of the method.") |
| 2026 | (Error VM_DEAD) |
| 2027 | ) |
| 2028 | ) |
| 2029 | |
| 2030 | ) |
| 2031 | (CommandSet ThreadGroupReference=12 |
| 2032 | (Command Name=1 |
| 2033 | "Returns the thread group name. " |
| 2034 | (Out |
| 2035 | (threadGroupObject group "The thread group object ID. ") |
| 2036 | ) |
| 2037 | (Reply |
| 2038 | (string groupName "The thread group's name.") |
| 2039 | ) |
| 2040 | (ErrorSet |
| 2041 | (Error INVALID_THREAD_GROUP) |
| 2042 | (Error INVALID_OBJECT "group is not a known ID.") |
| 2043 | (Error VM_DEAD) |
| 2044 | ) |
| 2045 | ) |
| 2046 | (Command Parent=2 |
| 2047 | "Returns the thread group, if any, which contains a given thread group. " |
| 2048 | (Out |
| 2049 | (threadGroupObject group "The thread group object ID. ") |
| 2050 | ) |
| 2051 | (Reply |
| 2052 | (threadGroupObject parentGroup "The parent thread group object, or " |
| 2053 | "null if the given thread group " |
| 2054 | "is a top-level thread group") |
| 2055 | ) |
| 2056 | (ErrorSet |
| 2057 | (Error INVALID_THREAD_GROUP) |
| 2058 | (Error INVALID_OBJECT "group is not a known ID.") |
| 2059 | (Error VM_DEAD) |
| 2060 | ) |
| 2061 | ) |
| 2062 | (Command Children=3 |
| 2063 | "Returns the live threads and active thread groups directly contained " |
| 2064 | "in this thread group. Threads and thread groups in child " |
| 2065 | "thread groups are not included. " |
| 2066 | "A thread is alive if it has been started and has not yet been stopped. " |
| 2067 | "See <a href=../../../api/java/lang/ThreadGroup.html>java.lang.ThreadGroup </a> |
| 2068 | "for information about active ThreadGroups. |
| 2069 | (Out |
| 2070 | (threadGroupObject group "The thread group object ID. ") |
| 2071 | ) |
| 2072 | (Reply |
| 2073 | (Repeat childThreads "The number of live child threads. " |
| 2074 | (threadObject childThread "A direct child thread ID. ") |
| 2075 | ) |
| 2076 | (Repeat childGroups "The number of active child thread groups. " |
| 2077 | (threadGroupObject childGroup "A direct child thread group ID. ") |
| 2078 | ) |
| 2079 | ) |
| 2080 | (ErrorSet |
| 2081 | (Error INVALID_THREAD_GROUP) |
| 2082 | (Error INVALID_OBJECT "group is not a known ID.") |
| 2083 | (Error VM_DEAD) |
| 2084 | ) |
| 2085 | ) |
| 2086 | ) |
| 2087 | (CommandSet ArrayReference=13 |
| 2088 | (Command Length=1 |
| 2089 | "Returns the number of components in a given array. " |
| 2090 | (Out |
| 2091 | (arrayObject arrayObject "The array object ID. ") |
| 2092 | ) |
| 2093 | (Reply |
| 2094 | (int arrayLength "The length of the array.") |
| 2095 | ) |
| 2096 | (ErrorSet |
| 2097 | (Error INVALID_OBJECT "arrayObject is not a known ID.") |
| 2098 | (Error INVALID_ARRAY) |
| 2099 | (Error VM_DEAD) |
| 2100 | ) |
| 2101 | ) |
| 2102 | (Command GetValues=2 |
| 2103 | "Returns a range of array components. The specified range must " |
| 2104 | "be within the bounds of the array. " |
| 2105 | (Out |
| 2106 | (arrayObject arrayObject "The array object ID. ") |
| 2107 | (int firstIndex "The first index to retrieve.") |
| 2108 | (int length "The number of components to retrieve.") |
| 2109 | ) |
| 2110 | (Reply |
| 2111 | (typed-sequence values "The retrieved values. If the values " |
| 2112 | "are objects, they are tagged-values; " |
| 2113 | "otherwise, they are untagged-values") |
| 2114 | ) |
| 2115 | (ErrorSet |
| 2116 | (Error INVALID_LENGTH "If index is beyond the end of this array.") |
| 2117 | (Error INVALID_OBJECT "arrayObject is not a known ID.") |
| 2118 | (Error INVALID_ARRAY) |
| 2119 | (Error VM_DEAD) |
| 2120 | ) |
| 2121 | ) |
| 2122 | (Command SetValues=3 |
| 2123 | "Sets a range of array components. The specified range must " |
| 2124 | "be within the bounds of the array. " |
| 2125 | "For primitive values, each value's type must match the " |
| 2126 | "array component type exactly. For object values, there must be a " |
| 2127 | "widening reference conversion from the value's type to the |
| 2128 | "array component type and the array component type must be loaded. " |
| 2129 | (Out |
| 2130 | (arrayObject arrayObject "The array object ID. ") |
| 2131 | (int firstIndex "The first index to set.") |
| 2132 | (Repeat values "The number of values to set. " |
| 2133 | (untagged-value value "A value to set. ") |
| 2134 | ) |
| 2135 | ) |
| 2136 | (Reply "none" |
| 2137 | ) |
| 2138 | (ErrorSet |
| 2139 | (Error INVALID_LENGTH "If index is beyond the end of this array.") |
| 2140 | (Error INVALID_OBJECT "arrayObject is not a known ID.") |
| 2141 | (Error INVALID_ARRAY) |
| 2142 | (Error VM_DEAD) |
| 2143 | ) |
| 2144 | ) |
| 2145 | ) |
| 2146 | (CommandSet ClassLoaderReference=14 |
| 2147 | (Command VisibleClasses=1 |
| 2148 | "Returns a list of all classes which this class loader has " |
| 2149 | "been requested to load. This class loader is considered to be " |
| 2150 | "an <i>initiating</i> class loader for each class in the returned " |
| 2151 | "list. The list contains each " |
| 2152 | "reference type defined by this loader and any types for which " |
| 2153 | "loading was delegated by this class loader to another class loader. " |
| 2154 | "<p>" |
| 2155 | "The visible class list has useful properties with respect to " |
| 2156 | "the type namespace. A particular type name will occur at most " |
| 2157 | "once in the list. Each field or variable declared with that " |
| 2158 | "type name in a class defined by " |
| 2159 | "this class loader must be resolved to that single type. " |
| 2160 | "<p>" |
| 2161 | "No ordering of the returned list is guaranteed. " |
| 2162 | (Out |
| 2163 | (classLoaderObject classLoaderObject "The class loader object ID. ") |
| 2164 | ) |
| 2165 | (Reply |
| 2166 | (Repeat classes "The number of visible classes. " |
| 2167 | (Group ClassInfo |
| 2168 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 2169 | "of following reference type. ") |
| 2170 | (referenceTypeID typeID |
| 2171 | "A class visible to this class loader.") |
| 2172 | ) |
| 2173 | ) |
| 2174 | ) |
| 2175 | (ErrorSet |
| 2176 | (Error INVALID_OBJECT) |
| 2177 | (Error INVALID_CLASS_LOADER) |
| 2178 | (Error VM_DEAD) |
| 2179 | ) |
| 2180 | ) |
| 2181 | ) |
| 2182 | (CommandSet EventRequest=15 |
| 2183 | (Command Set=1 |
| 2184 | "Set an event request. When the event described by this request " |
| 2185 | "occurs, an <a href=\"#JDWP_Event\">event</a> is sent from the " |
| 2186 | "target VM. If an event occurs that has not been requested then it is not sent " |
| 2187 | "from the target VM. The two exceptions to this are the VM Start Event and " |
| 2188 | "the VM Death Event which are automatically generated events - see " |
| 2189 | "<a href=\"#JDWP_Event_Composite\">Composite Command</a> for further details." |
| 2190 | (Out |
| 2191 | (byte eventKind "Event kind to request. " |
| 2192 | "See <a href=\"#JDWP_EventKind\">JDWP.EventKind</a> " |
| 2193 | "for a complete list of events that can be requested; " |
| 2194 | "some events may require a capability in order to be requested. " |
| 2195 | ) |
| 2196 | (byte suspendPolicy |
| 2197 | "What threads are suspended when this event occurs? " |
| 2198 | "Note that the order of events and command replies " |
| 2199 | "accurately reflects the order in which threads are " |
| 2200 | "suspended and resumed. For example, if a " |
| 2201 | "<a href=\"#JDWP_VirtualMachine_Resume\">VM-wide resume</a> " |
| 2202 | "is processed before an event occurs which suspends the " |
| 2203 | "VM, the reply to the resume command will be written to " |
| 2204 | "the transport before the suspending event.") |
| 2205 | (Repeat modifiers "Constraints used to control the number " |
| 2206 | "of generated events." |
| 2207 | "Modifiers specify additional tests that " |
| 2208 | "an event must satisfy before it is placed " |
| 2209 | "in the event queue. Events are filtered by " |
| 2210 | "applying each modifier to an event in the " |
| 2211 | "order they are specified in this collection " |
| 2212 | "Only events that satisfy all modifiers " |
| 2213 | "are reported. A value of 0 means there are no " |
| 2214 | "modifiers in the request." |
| 2215 | "<p>" |
| 2216 | "Filtering can improve " |
| 2217 | "debugger performance dramatically by |
| 2218 | "reducing the " |
| 2219 | "amount of event traffic sent from the " |
| 2220 | "target VM to the debugger VM. " |
| 2221 | (Select Modifier |
| 2222 | (byte modKind "Modifier kind") |
| 2223 | (Alt Count=1 |
| 2224 | "Limit the requested event to be reported at most once after a " |
| 2225 | "given number of occurrences. The event is not reported " |
| 2226 | "the first <code>count - 1</code> times this filter is reached. " |
| 2227 | "To request a one-off event, call this method with a count of 1. " |
| 2228 | "<p>" |
| 2229 | "Once the count reaches 0, any subsequent filters in this request " |
| 2230 | "are applied. If none of those filters cause the event to be " |
| 2231 | "suppressed, the event is reported. Otherwise, the event is not " |
| 2232 | "reported. In either case subsequent events are never reported for " |
| 2233 | "this request. " |
| 2234 | "This modifier can be used with any event kind." |
| 2235 | |
| 2236 | (int count "Count before event. One for one-off.") |
| 2237 | ) |
| 2238 | (Alt Conditional=2 "Conditional on expression" |
| 2239 | (int exprID "For the future") |
| 2240 | ) |
| 2241 | (Alt ThreadOnly=3 |
| 2242 | "Restricts reported events to " |
| 2243 | "those in the given thread. " |
| 2244 | "This modifier can be used with any event kind " |
| 2245 | "except for class unload. " |
| 2246 | |
| 2247 | (threadObject thread "Required thread") |
| 2248 | ) |
| 2249 | (Alt ClassOnly=4 |
| 2250 | "For class prepare events, restricts the events " |
| 2251 | "generated by this request to be the " |
| 2252 | "preparation of the given reference type and any subtypes. " |
| 2253 | "For monitor wait and waited events, restricts the events " |
| 2254 | "generated by this request to those whose monitor object " |
| 2255 | "is of the given reference type or any of its subtypes. " |
| 2256 | "For other events, restricts the events generated " |
| 2257 | "by this request to those " |
| 2258 | "whose location is in the given reference type or any of its subtypes. " |
| 2259 | "An event will be generated for any location in a reference type that can " |
| 2260 | "be safely cast to the given reference type. " |
| 2261 | "This modifier can be used with any event kind except " |
| 2262 | "class unload, thread start, and thread end. " |
| 2263 | |
| 2264 | (referenceType clazz "Required class") |
| 2265 | ) |
| 2266 | (Alt ClassMatch=5 |
| 2267 | "Restricts reported events to those for classes whose name " |
| 2268 | "matches the given restricted regular expression. " |
| 2269 | "For class prepare events, the prepared class name " |
| 2270 | "is matched. For class unload events, the " |
| 2271 | "unloaded class name is matched. For monitor wait " |
| 2272 | "and waited events, the name of the class of the " |
| 2273 | "monitor object is matched. For other events, " |
| 2274 | "the class name of the event's location is matched. " |
| 2275 | "This modifier can be used with any event kind except " |
| 2276 | "thread start and thread end. " |
| 2277 | |
| 2278 | (string classPattern "Required class pattern. " |
| 2279 | "Matches are limited to exact matches of the " |
| 2280 | "given class pattern and matches of patterns that " |
| 2281 | "begin or end with '*'; for example, " |
| 2282 | "\"*.Foo\" or \"java.*\". " |
| 2283 | ) |
| 2284 | |
| 2285 | ) |
| 2286 | (Alt ClassExclude=6 |
| 2287 | "Restricts reported events to those for classes whose name " |
| 2288 | "does not match the given restricted regular expression. " |
| 2289 | "For class prepare events, the prepared class name " |
| 2290 | "is matched. For class unload events, the " |
| 2291 | "unloaded class name is matched. For monitor wait and " |
| 2292 | "waited events, the name of the class of the monitor " |
| 2293 | "object is matched. For other events, " |
| 2294 | "the class name of the event's location is matched. " |
| 2295 | "This modifier can be used with any event kind except " |
| 2296 | "thread start and thread end. " |
| 2297 | |
| 2298 | (string classPattern "Disallowed class pattern. " |
| 2299 | "Matches are limited to exact matches of the " |
| 2300 | "given class pattern and matches of patterns that " |
| 2301 | "begin or end with '*'; for example, " |
| 2302 | "\"*.Foo\" or \"java.*\". " |
| 2303 | ) |
| 2304 | ) |
| 2305 | (Alt LocationOnly=7 |
| 2306 | "Restricts reported events to those that occur at " |
| 2307 | "the given location. " |
| 2308 | "This modifier can be used with " |
| 2309 | "breakpoint, field access, field modification, " |
| 2310 | "step, and exception event kinds. " |
| 2311 | |
| 2312 | (location loc "Required location") |
| 2313 | ) |
| 2314 | (Alt ExceptionOnly=8 |
| 2315 | "Restricts reported exceptions by their class and " |
| 2316 | "whether they are caught or uncaught. " |
| 2317 | "This modifier can be used with " |
| 2318 | "exception event kinds only. " |
| 2319 | |
| 2320 | (referenceType exceptionOrNull |
| 2321 | "Exception to report. Null (0) means report " |
| 2322 | "exceptions of all types. " |
| 2323 | "A non-null type restricts the reported exception " |
| 2324 | "events to exceptions of the given type or " |
| 2325 | "any of its subtypes. " |
| 2326 | ) |
| 2327 | (boolean caught "Report caught exceptions") |
| 2328 | (boolean uncaught "Report uncaught exceptions. " |
| 2329 | "Note that it " |
| 2330 | "is not always possible to determine whether an " |
| 2331 | "exception is caught or uncaught at the time it is " |
| 2332 | "thrown. See the exception event catch location under " |
| 2333 | "<a href=\"#JDWP_Event_Composite\">composite events</a> " |
| 2334 | "for more information. " |
| 2335 | ) |
| 2336 | |
| 2337 | ) |
| 2338 | (Alt FieldOnly=9 |
| 2339 | "Restricts reported events to those that occur for " |
| 2340 | "a given field. " |
| 2341 | "This modifier can be used with " |
| 2342 | "field access and field modification event kinds only. " |
| 2343 | |
| 2344 | (referenceType declaring "Type in which field is declared.") |
| 2345 | (field fieldID "Required field") |
| 2346 | ) |
| 2347 | (Alt Step=10 |
| 2348 | "Restricts reported step events " |
| 2349 | "to those which satisfy " |
| 2350 | "depth and size constraints. " |
| 2351 | "This modifier can be used with " |
| 2352 | "step event kinds only. " |
| 2353 | |
| 2354 | (threadObject thread "Thread in which to step") |
| 2355 | (int size "size of each step. " |
| 2356 | "See <a href=\"#JDWP_StepSize\">JDWP.StepSize</a>") |
| 2357 | (int depth "relative call stack limit. " |
| 2358 | "See <a href=\"#JDWP_StepDepth\">JDWP.StepDepth</a>") |
| 2359 | ) |
| 2360 | (Alt InstanceOnly=11 |
| 2361 | "Restricts reported events to those whose " |
| 2362 | "active 'this' object is the given object. " |
| 2363 | "Match value is the null object for static methods. " |
| 2364 | "This modifier can be used with any event kind " |
| 2365 | "except class prepare, class unload, thread start, " |
| 2366 | "and thread end. Introduced in JDWP version 1.4." |
| 2367 | |
| 2368 | (object instance "Required 'this' object") |
| 2369 | ) |
| 2370 | (Alt SourceNameMatch=12 |
| 2371 | "Restricts reported class prepare events to those " |
| 2372 | "for reference types which have a source name " |
| 2373 | "which matches the given restricted regular expression. " |
| 2374 | "The source names are determined by the reference type's " |
| 2375 | "<a href=\"#JDWP_ReferenceType_SourceDebugExtension\"> " |
| 2376 | "SourceDebugExtension</a>. " |
| 2377 | "This modifier can only be used with class prepare " |
| 2378 | "events. " |
| 2379 | "Since JDWP version 1.6. Requires the canUseSourceNameFilters " |
| 2380 | "capability - see " |
| 2381 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 2382 | |
| 2383 | (string sourceNamePattern "Required source name pattern. " |
| 2384 | "Matches are limited to exact matches of the " |
| 2385 | "given pattern and matches of patterns that " |
| 2386 | "begin or end with '*'; for example, " |
| 2387 | "\"*.Foo\" or \"java.*\". " |
| 2388 | ) |
| 2389 | ) |
| 2390 | |
| 2391 | ) |
| 2392 | ) |
| 2393 | ) |
| 2394 | (Reply |
| 2395 | (int requestID "ID of created request") |
| 2396 | ) |
| 2397 | (ErrorSet |
| 2398 | (Error INVALID_THREAD) |
| 2399 | (Error INVALID_CLASS) |
| 2400 | (Error INVALID_STRING) |
| 2401 | (Error INVALID_OBJECT) |
| 2402 | (Error INVALID_COUNT) |
| 2403 | (Error INVALID_FIELDID) |
| 2404 | (Error INVALID_METHODID) |
| 2405 | (Error INVALID_LOCATION) |
| 2406 | (Error INVALID_EVENT_TYPE) |
| 2407 | (Error NOT_IMPLEMENTED) |
| 2408 | (Error VM_DEAD) |
| 2409 | ) |
| 2410 | ) |
| 2411 | (Command Clear=2 |
| 2412 | "Clear an event request. See <a href=\"#JDWP_EventKind\">JDWP.EventKind</a> " |
| 2413 | "for a complete list of events that can be cleared. Only the event request matching " |
| 2414 | "the specified event kind and requestID is cleared. If there isn't a matching event " |
| 2415 | "request the command is a no-op and does not result in an error. Automatically " |
| 2416 | "generated events do not have a corresponding event request and may not be cleared " |
| 2417 | "using this command." |
| 2418 | (Out |
| 2419 | (byte eventKind "Event kind to clear") |
| 2420 | (int requestID "ID of request to clear") |
| 2421 | ) |
| 2422 | (Reply "none" |
| 2423 | ) |
| 2424 | (ErrorSet |
| 2425 | (Error VM_DEAD) |
| 2426 | (Error INVALID_EVENT_TYPE) |
| 2427 | ) |
| 2428 | ) |
| 2429 | (Command ClearAllBreakpoints=3 |
| 2430 | "Removes all set breakpoints, a no-op if there are no breakpoints set." |
| 2431 | (Out "none" |
| 2432 | ) |
| 2433 | (Reply "none" |
| 2434 | ) |
| 2435 | (ErrorSet |
| 2436 | (Error VM_DEAD) |
| 2437 | ) |
| 2438 | ) |
| 2439 | ) |
| 2440 | (CommandSet StackFrame=16 |
| 2441 | (Command GetValues=1 |
| 2442 | "Returns the value of one or more local variables in a " |
| 2443 | "given frame. Each variable must be visible at the frame's code index. " |
| 2444 | "Even if local variable information is not available, values can " |
| 2445 | "be retrieved if the front-end is able to " |
| 2446 | "determine the correct local variable index. (Typically, this " |
| 2447 | "index can be determined for method arguments from the method " |
| 2448 | "signature without access to the local variable table information.) " |
| 2449 | (Out |
| 2450 | (threadObject thread "The frame's thread. ") |
| 2451 | (frame frame "The frame ID. ") |
| 2452 | (Repeat slots "The number of values to get. " |
| 2453 | (Group SlotInfo |
| 2454 | (int slot "The local variable's index in the frame. ") |
| 2455 | (byte sigbyte "A <a href=\"#JDWP_Tag\">tag</a> " |
| 2456 | "identifying the type of the variable ") |
| 2457 | ) |
| 2458 | ) |
| 2459 | ) |
| 2460 | (Reply |
| 2461 | (Repeat values "The number of values retrieved, always equal to slots, " |
| 2462 | "the number of values to get." |
| 2463 | (value slotValue "The value of the local variable. ") |
| 2464 | ) |
| 2465 | ) |
| 2466 | (ErrorSet |
| 2467 | (Error INVALID_THREAD) |
| 2468 | (Error INVALID_OBJECT) |
| 2469 | (Error INVALID_FRAMEID) |
| 2470 | (Error INVALID_SLOT) |
| 2471 | (Error VM_DEAD) |
| 2472 | ) |
| 2473 | ) |
| 2474 | (Command SetValues=2 |
| 2475 | "Sets the value of one or more local variables. " |
| 2476 | "Each variable must be visible at the current frame code index. " |
| 2477 | "For primitive values, the value's type must match the " |
| 2478 | "variable's type exactly. For object values, there must be a " |
| 2479 | "widening reference conversion from the value's type to the |
| 2480 | "variable's type and the variable's type must be loaded. " |
| 2481 | "<p>" |
| 2482 | "Even if local variable information is not available, values can " |
| 2483 | "be set, if the front-end is able to " |
| 2484 | "determine the correct local variable index. (Typically, this |
| 2485 | "index can be determined for method arguments from the method " |
| 2486 | "signature without access to the local variable table information.) " |
| 2487 | (Out |
| 2488 | (threadObject thread "The frame's thread. ") |
| 2489 | (frame frame "The frame ID. ") |
| 2490 | (Repeat slotValues "The number of values to set. " |
| 2491 | (Group SlotInfo |
| 2492 | (int slot "The slot ID. ") |
| 2493 | (value slotValue "The value to set. ") |
| 2494 | ) |
| 2495 | ) |
| 2496 | ) |
| 2497 | (Reply "none" |
| 2498 | ) |
| 2499 | (ErrorSet |
| 2500 | (Error INVALID_THREAD) |
| 2501 | (Error INVALID_OBJECT) |
| 2502 | (Error INVALID_FRAMEID) |
| 2503 | (Error VM_DEAD) |
| 2504 | ) |
| 2505 | ) |
| 2506 | (Command ThisObject=3 |
| 2507 | "Returns the value of the 'this' reference for this frame. " |
| 2508 | "If the frame's method is static or native, the reply " |
| 2509 | "will contain the null object reference. " |
| 2510 | (Out |
| 2511 | (threadObject thread "The frame's thread. ") |
| 2512 | (frame frame "The frame ID. ") |
| 2513 | ) |
| 2514 | (Reply |
| 2515 | (tagged-object objectThis "The 'this' object for this frame. ") |
| 2516 | ) |
| 2517 | (ErrorSet |
| 2518 | (Error INVALID_THREAD) |
| 2519 | (Error INVALID_OBJECT) |
| 2520 | (Error INVALID_FRAMEID) |
| 2521 | (Error VM_DEAD) |
| 2522 | ) |
| 2523 | ) |
| 2524 | (Command PopFrames=4 |
| 2525 | "Pop the top-most stack frames of the thread stack, up to, and including 'frame'. " |
| 2526 | "The thread must be suspended to perform this command. " |
| 2527 | "The top-most stack frames are discarded and the stack frame previous to 'frame' " |
| 2528 | "becomes the current frame. The operand stack is restored -- the argument values " |
| 2529 | "are added back and if the invoke was not <code>invokestatic</code>, " |
| 2530 | "<code>objectref</code> is added back as well. The Java virtual machine " |
| 2531 | "program counter is restored to the opcode of the invoke instruction." |
| 2532 | "<p>" |
| 2533 | "Since JDWP version 1.4. Requires canPopFrames capability - see " |
| 2534 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 2535 | (Out |
| 2536 | (threadObject thread "The thread object ID. ") |
| 2537 | (frame frame "The frame ID. ") |
| 2538 | ) |
| 2539 | (Reply "none" |
| 2540 | ) |
| 2541 | (ErrorSet |
| 2542 | (Error INVALID_THREAD) |
| 2543 | (Error INVALID_OBJECT "thread is not a known ID.") |
| 2544 | (Error INVALID_FRAMEID) |
| 2545 | (Error THREAD_NOT_SUSPENDED) |
| 2546 | (Error NO_MORE_FRAMES) |
| 2547 | (Error INVALID_FRAMEID) |
| 2548 | (Error NOT_IMPLEMENTED) |
| 2549 | (Error VM_DEAD) |
| 2550 | ) |
| 2551 | ) |
| 2552 | ) |
| 2553 | (CommandSet ClassObjectReference=17 |
| 2554 | (Command ReflectedType = 1 |
| 2555 | "Returns the reference type reflected by this class object." |
| 2556 | (Out |
| 2557 | (classObject classObject "The class object. ") |
| 2558 | ) |
| 2559 | (Reply |
| 2560 | (byte refTypeTag "<a href=\"#JDWP_TypeTag\">Kind</a> " |
| 2561 | "of following reference type. ") |
| 2562 | (referenceTypeID typeID "reflected reference type") |
| 2563 | ) |
| 2564 | (ErrorSet |
| 2565 | (Error INVALID_OBJECT) |
| 2566 | (Error VM_DEAD) |
| 2567 | ) |
| 2568 | ) |
| 2569 | ) |
| 2570 | (CommandSet Event=64 |
| 2571 | (Command Composite=100 |
| 2572 | "Several events may occur at a given time in the target VM. " |
| 2573 | "For example, there may be more than one breakpoint request " |
| 2574 | "for a given location " |
| 2575 | "or you might single step to the same location as a " |
| 2576 | "breakpoint request. These events are delivered " |
| 2577 | "together as a composite event. For uniformity, a " |
| 2578 | "composite event is always used " |
| 2579 | "to deliver events, even if there is only one event to report. " |
| 2580 | "<P>" |
| 2581 | "The events that are grouped in a composite event are restricted in the " |
| 2582 | "following ways: " |
| 2583 | "<P>" |
| 2584 | "<UL>" |
| 2585 | "<LI>Only with other thread start events for the same thread:" |
| 2586 | " <UL>" |
| 2587 | " <LI>Thread Start Event" |
| 2588 | " </UL>" |
| 2589 | "<LI>Only with other thread death events for the same thread:" |
| 2590 | " <UL>" |
| 2591 | " <LI>Thread Death Event" |
| 2592 | " </UL>" |
| 2593 | "<LI>Only with other class prepare events for the same class:" |
| 2594 | " <UL>" |
| 2595 | " <LI>Class Prepare Event" |
| 2596 | " </UL>" |
| 2597 | "<LI>Only with other class unload events for the same class:" |
| 2598 | " <UL>" |
| 2599 | " <LI>Class Unload Event" |
| 2600 | " </UL>" |
| 2601 | "<LI>Only with other access watchpoint events for the same field access:" |
| 2602 | " <UL>" |
| 2603 | " <LI>Access Watchpoint Event" |
| 2604 | " </UL>" |
| 2605 | "<LI>Only with other modification watchpoint events for the same field " |
| 2606 | "modification:" |
| 2607 | " <UL>" |
| 2608 | " <LI>Modification Watchpoint Event" |
| 2609 | " </UL>" |
| 2610 | "<LI>Only with other Monitor contended enter events for the same monitor object: " |
| 2611 | " <UL>" |
| 2612 | " <LI>Monitor Contended Enter Event" |
| 2613 | " </UL>" |
| 2614 | "<LI>Only with other Monitor contended entered events for the same monitor object: " |
| 2615 | " <UL>" |
| 2616 | " <LI>Monitor Contended Entered Event" |
| 2617 | " </UL>" |
| 2618 | "<LI>Only with other Monitor wait events for the same monitor object: " |
| 2619 | " <UL>" |
| 2620 | " <LI>Monitor Wait Event" |
| 2621 | " </UL>" |
| 2622 | "<LI>Only with other Monitor waited events for the same monitor object: " |
| 2623 | " <UL>" |
| 2624 | " <LI>Monitor Waited Event" |
| 2625 | " </UL>" |
| 2626 | "<LI>Only with other ExceptionEvents for the same exception occurrance:" |
| 2627 | " <UL>" |
| 2628 | " <LI>ExceptionEvent" |
| 2629 | " </UL>" |
| 2630 | "<LI>Only with other members of this group, at the same location " |
| 2631 | "and in the same thread: " |
| 2632 | " <UL>" |
| 2633 | " <LI>Breakpoint Event" |
| 2634 | " <LI>Step Event" |
| 2635 | " <LI>Method Entry Event" |
| 2636 | " <LI>Method Exit Event" |
| 2637 | " </UL>" |
| 2638 | "</UL>" |
| 2639 | "<P>" |
| 2640 | "The VM Start Event and VM Death Event are automatically generated events. " |
| 2641 | "This means they do not need to be requested using the " |
| 2642 | "<a href=\"#JDWP_EventRequest_Set\">EventRequest.Set</a> command. " |
| 2643 | "The VM Start event signals the completion of VM initialization. The VM Death " |
| 2644 | "event signals the termination of the VM." |
| 2645 | "If there is a debugger connected at the time when an automatically generated " |
| 2646 | "event occurs it is sent from the target VM. Automatically generated events may " |
| 2647 | "also be requested using the EventRequest.Set command and thus multiple events " |
| 2648 | "of the same event kind will be sent from the target VM when an event occurs." |
| 2649 | "Automatically generated events are sent with the requestID field " |
| 2650 | "in the Event Data set to 0. The value of the suspendPolicy field in the " |
| 2651 | "Event Data depends on the event. For the automatically generated VM Start " |
| 2652 | "Event the value of suspendPolicy is not defined and is therefore implementation " |
| 2653 | "or configuration specific. In the Sun implementation, for example, the " |
| 2654 | "suspendPolicy is specified as an option to the JDWP agent at launch-time." |
| 2655 | "The automatically generated VM Death Event will have the suspendPolicy set to " |
| 2656 | "NONE." |
| 2657 | |
| 2658 | (Event "Generated event" |
| 2659 | (byte suspendPolicy |
| 2660 | "Which threads where suspended by this composite event?") |
| 2661 | (Repeat events "Events in set." |
| 2662 | (Select Events |
| 2663 | (byte eventKind "Event kind selector") |
| 2664 | (Alt VMStart=JDWP.EventKind.VM_START |
| 2665 | "Notification of initialization of a target VM. This event is " |
| 2666 | "received before the main thread is started and before any " |
| 2667 | "application code has been executed. Before this event occurs " |
| 2668 | "a significant amount of system code has executed and a number " |
| 2669 | "of system classes have been loaded. " |
| 2670 | "This event is always generated by the target VM, even " |
| 2671 | "if not explicitly requested." |
| 2672 | |
| 2673 | (int requestID |
| 2674 | "Request that generated event (or 0 if this " |
| 2675 | "event is automatically generated.") |
| 2676 | (threadObject thread "Initial thread") |
| 2677 | ) |
| 2678 | (Alt SingleStep=JDWP.EventKind.SINGLE_STEP |
| 2679 | "Notification of step completion in the target VM. The step event " |
| 2680 | "is generated before the code at its location is executed. " |
| 2681 | |
| 2682 | (int requestID "Request that generated event") |
| 2683 | (threadObject thread "Stepped thread") |
| 2684 | (location location "Location stepped to") |
| 2685 | ) |
| 2686 | (Alt Breakpoint=JDWP.EventKind.BREAKPOINT |
| 2687 | "Notification of a breakpoint in the target VM. The breakpoint event " |
| 2688 | "is generated before the code at its location is executed. " |
| 2689 | |
| 2690 | (int requestID "Request that generated event") |
| 2691 | (threadObject thread "Thread which hit breakpoint") |
| 2692 | (location location "Location hit") |
| 2693 | ) |
| 2694 | (Alt MethodEntry=JDWP.EventKind.METHOD_ENTRY |
| 2695 | "Notification of a method invocation in the target VM. This event " |
| 2696 | "is generated before any code in the invoked method has executed. " |
| 2697 | "Method entry events are generated for both native and non-native " |
| 2698 | "methods. " |
| 2699 | "<P>" |
| 2700 | "In some VMs method entry events can occur for a particular thread " |
| 2701 | "before its thread start event occurs if methods are called " |
| 2702 | "as part of the thread's initialization. " |
| 2703 | |
| 2704 | (int requestID "Request that generated event") |
| 2705 | (threadObject thread "Thread which entered method") |
| 2706 | (location location "The initial executable location in the method.") |
| 2707 | ) |
| 2708 | (Alt MethodExit=JDWP.EventKind.METHOD_EXIT |
| 2709 | "Notification of a method return in the target VM. This event " |
| 2710 | "is generated after all code in the method has executed, but the " |
| 2711 | "location of this event is the last executed location in the method. " |
| 2712 | "Method exit events are generated for both native and non-native " |
| 2713 | "methods. Method exit events are not generated if the method terminates " |
| 2714 | "with a thrown exception. " |
| 2715 | |
| 2716 | (int requestID "Request that generated event") |
| 2717 | (threadObject thread "Thread which exited method") |
| 2718 | (location location "Location of exit") |
| 2719 | ) |
| 2720 | (Alt MethodExitWithReturnValue=JDWP.EventKind.METHOD_EXIT_WITH_RETURN_VALUE |
| 2721 | "Notification of a method return in the target VM. This event " |
| 2722 | "is generated after all code in the method has executed, but the " |
| 2723 | "location of this event is the last executed location in the method. " |
| 2724 | "Method exit events are generated for both native and non-native " |
| 2725 | "methods. Method exit events are not generated if the method terminates " |
| 2726 | "with a thrown exception. <p>Since JDWP version 1.6. " |
| 2727 | |
| 2728 | (int requestID "Request that generated event") |
| 2729 | (threadObject thread "Thread which exited method") |
| 2730 | (location location "Location of exit") |
| 2731 | (value value "Value that will be returned by the method") |
| 2732 | ) |
| 2733 | (Alt MonitorContendedEnter=JDWP.EventKind.MONITOR_CONTENDED_ENTER |
| 2734 | "Notification that a thread in the target VM is attempting " |
| 2735 | "to enter a monitor that is already acquired by another thread. " |
| 2736 | "Requires canRequestMonitorEvents capability - see " |
| 2737 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 2738 | "<p>Since JDWP version 1.6. " |
| 2739 | |
| 2740 | (int requestID |
| 2741 | "Request that generated event") |
| 2742 | (threadObject thread "Thread which is trying to enter the monitor") |
| 2743 | (tagged-object object "Monitor object reference") |
| 2744 | (location location "Location of contended monitor enter") |
| 2745 | ) |
| 2746 | (Alt MonitorContendedEntered=JDWP.EventKind.MONITOR_CONTENDED_ENTERED |
| 2747 | "Notification of a thread in the target VM is entering a monitor " |
| 2748 | "after waiting for it to be released by another thread. " |
| 2749 | "Requires canRequestMonitorEvents capability - see " |
| 2750 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 2751 | "<p>Since JDWP version 1.6. " |
| 2752 | |
| 2753 | (int requestID |
| 2754 | "Request that generated event") |
| 2755 | (threadObject thread "Thread which entered monitor") |
| 2756 | (tagged-object object "Monitor object reference") |
| 2757 | (location location "Location of contended monitor enter") |
| 2758 | ) |
| 2759 | (Alt MonitorWait=JDWP.EventKind.MONITOR_WAIT |
| 2760 | "Notification of a thread about to wait on a monitor object. " |
| 2761 | "Requires canRequestMonitorEvents capability - see " |
| 2762 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 2763 | "<p>Since JDWP version 1.6. " |
| 2764 | |
| 2765 | (int requestID |
| 2766 | "Request that generated event") |
| 2767 | (threadObject thread "Thread which is about to wait") |
| 2768 | (tagged-object object "Monitor object reference") |
| 2769 | (location location "Location at which the wait will occur") |
| 2770 | (long timeout "Thread wait time in milliseconds") |
| 2771 | ) |
| 2772 | (Alt MonitorWaited=JDWP.EventKind.MONITOR_WAITED |
| 2773 | "Notification that a thread in the target VM has finished waiting on " |
| 2774 | "Requires canRequestMonitorEvents capability - see " |
| 2775 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>. " |
| 2776 | "a monitor object. " |
| 2777 | "<p>Since JDWP version 1.6. " |
| 2778 | |
| 2779 | (int requestID |
| 2780 | "Request that generated event") |
| 2781 | (threadObject thread "Thread which waited") |
| 2782 | (tagged-object object "Monitor object reference") |
| 2783 | (location location "Location at which the wait occured") |
| 2784 | (boolean timed_out "True if timed out") |
| 2785 | ) |
| 2786 | (Alt Exception=JDWP.EventKind.EXCEPTION |
| 2787 | "Notification of an exception in the target VM. " |
| 2788 | "If the exception is thrown from a non-native method, " |
| 2789 | "the exception event is generated at the location where the " |
| 2790 | "exception is thrown. " |
| 2791 | "If the exception is thrown from a native method, the exception event " |
| 2792 | "is generated at the first non-native location reached after the exception " |
| 2793 | "is thrown. " |
| 2794 | |
| 2795 | (int requestID "Request that generated event") |
| 2796 | (threadObject thread "Thread with exception") |
| 2797 | (location location "Location of exception throw " |
| 2798 | "(or first non-native location after throw if thrown from a native method)") |
| 2799 | (tagged-object exception "Thrown exception") |
| 2800 | (location catchLocation |
| 2801 | "Location of catch, or 0 if not caught. An exception " |
| 2802 | "is considered to be caught if, at the point of the throw, the " |
| 2803 | "current location is dynamically enclosed in a try statement that " |
| 2804 | "handles the exception. (See the JVM specification for details). " |
| 2805 | "If there is such a try statement, the catch location is the " |
| 2806 | "first location in the appropriate catch clause. " |
| 2807 | "<p>" |
| 2808 | "If there are native methods in the call stack at the time of the " |
| 2809 | "exception, there are important restrictions to note about the " |
| 2810 | "returned catch location. In such cases, " |
| 2811 | "it is not possible to predict whether an exception will be handled " |
| 2812 | "by some native method on the call stack. " |
| 2813 | "Thus, it is possible that exceptions considered uncaught " |
| 2814 | "here will, in fact, be handled by a native method and not cause " |
| 2815 | "termination of the target VM. Furthermore, it cannot be assumed that the " |
| 2816 | "catch location returned here will ever be reached by the throwing " |
| 2817 | "thread. If there is " |
| 2818 | "a native frame between the current location and the catch location, " |
| 2819 | "the exception might be handled and cleared in that native method " |
| 2820 | "instead. " |
| 2821 | "<p>" |
| 2822 | "Note that compilers can generate try-catch blocks in some cases " |
| 2823 | "where they are not explicit in the source code; for example, " |
| 2824 | "the code generated for <code>synchronized</code> and " |
| 2825 | "<code>finally</code> blocks can contain implicit try-catch blocks. " |
| 2826 | "If such an implicitly generated try-catch is " |
| 2827 | "present on the call stack at the time of the throw, the exception " |
| 2828 | "will be considered caught even though it appears to be uncaught from " |
| 2829 | "examination of the source code. " |
| 2830 | ) |
| 2831 | ) |
| 2832 | (Alt ThreadStart=JDWP.EventKind.THREAD_START |
| 2833 | "Notification of a new running thread in the target VM. " |
| 2834 | "The new thread can be the result of a call to " |
| 2835 | "<code>java.lang.Thread.start</code> or the result of " |
| 2836 | "attaching a new thread to the VM though JNI. The " |
| 2837 | "notification is generated by the new thread some time before " |
| 2838 | "its execution starts. " |
| 2839 | "Because of this timing, it is possible to receive other events " |
| 2840 | "for the thread before this event is received. (Notably, " |
| 2841 | "Method Entry Events and Method Exit Events might occur " |
| 2842 | "during thread initialization. " |
| 2843 | "It is also possible for the " |
| 2844 | "<a href=\"#JDWP_VirtualMachine_AllThreads\">VirtualMachine AllThreads</a> " |
| 2845 | "command to return " |
| 2846 | "a thread before its thread start event is received. " |
| 2847 | "<p>" |
| 2848 | "Note that this event gives no information " |
| 2849 | "about the creation of the thread object which may have happened " |
| 2850 | "much earlier, depending on the VM being debugged. " |
| 2851 | |
| 2852 | (int requestID "Request that generated event") |
| 2853 | (threadObject thread "Started thread") |
| 2854 | ) |
| 2855 | (Alt ThreadDeath=JDWP.EventKind.THREAD_DEATH |
| 2856 | "Notification of a completed thread in the target VM. The " |
| 2857 | "notification is generated by the dying thread before it terminates. " |
| 2858 | "Because of this timing, it is possible " |
| 2859 | "for {@link VirtualMachine#allThreads} to return this thread " |
| 2860 | "after this event is received. " |
| 2861 | "<p>" |
| 2862 | "Note that this event gives no information " |
| 2863 | "about the lifetime of the thread object. It may or may not be collected " |
| 2864 | "soon depending on what references exist in the target VM. " |
| 2865 | |
| 2866 | (int requestID "Request that generated event") |
| 2867 | (threadObject thread "Ending thread") |
| 2868 | ) |
| 2869 | (Alt ClassPrepare=JDWP.EventKind.CLASS_PREPARE |
| 2870 | "Notification of a class prepare in the target VM. See the JVM " |
| 2871 | "specification for a definition of class preparation. Class prepare " |
| 2872 | "events are not generated for primtiive classes (for example, " |
| 2873 | "java.lang.Integer.TYPE). " |
| 2874 | |
| 2875 | (int requestID "Request that generated event") |
| 2876 | (threadObject thread "Preparing thread. " |
| 2877 | "In rare cases, this event may occur in a debugger system " |
| 2878 | "thread within the target VM. Debugger threads take precautions " |
| 2879 | "to prevent these events, but they cannot be avoided under some " |
| 2880 | "conditions, especially for some subclasses of " |
| 2881 | "java.lang.Error. " |
| 2882 | "If the event was generated by a debugger system thread, the " |
| 2883 | "value returned by this method is null, and if the requested " |
| 2884 | "<a href=\"#JDWP_SuspendPolicy\">suspend policy</a> " |
| 2885 | "for the event was EVENT_THREAD " |
| 2886 | "all threads will be suspended instead, and the " |
| 2887 | "composite event's suspend policy will reflect this change. " |
| 2888 | "<p>" |
| 2889 | "Note that the discussion above does not apply to system threads " |
| 2890 | "created by the target VM during its normal (non-debug) operation. " |
| 2891 | ) |
| 2892 | (byte refTypeTag "Kind of reference type. " |
| 2893 | "See <a href=\"#JDWP_TypeTag\">JDWP.TypeTag</a>") |
| 2894 | (referenceTypeID typeID "Type being prepared") |
| 2895 | (string signature "Type signature") |
| 2896 | (int status "Status of type. " |
| 2897 | "See <a href=\"#JDWP_ClassStatus\">JDWP.ClassStatus</a>") |
| 2898 | ) |
| 2899 | (Alt ClassUnload=JDWP.EventKind.CLASS_UNLOAD |
| 2900 | "Notification of a class unload in the target VM. " |
| 2901 | "<p>" |
| 2902 | "There are severe constraints on the debugger back-end during " |
| 2903 | "garbage collection, so unload information is greatly limited. " |
| 2904 | |
| 2905 | (int requestID "Request that generated event") |
| 2906 | (string signature "Type signature") |
| 2907 | ) |
| 2908 | (Alt FieldAccess=JDWP.EventKind.FIELD_ACCESS |
| 2909 | "Notification of a field access in the target VM. " |
| 2910 | "Field modifications " |
| 2911 | "are not considered field accesses. " |
| 2912 | "Requires canWatchFieldAccess capability - see " |
| 2913 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 2914 | |
| 2915 | (int requestID "Request that generated event") |
| 2916 | (threadObject thread "Accessing thread") |
| 2917 | (location location "Location of access") |
| 2918 | (byte refTypeTag "Kind of reference type. " |
| 2919 | "See <a href=\"#JDWP_TypeTag\">JDWP.TypeTag</a>") |
| 2920 | (referenceTypeID typeID "Type of field") |
| 2921 | (field fieldID "Field being accessed") |
| 2922 | (tagged-object object |
| 2923 | "Object being accessed (null=0 for statics") |
| 2924 | ) |
| 2925 | (Alt FieldModification=JDWP.EventKind.FIELD_MODIFICATION |
| 2926 | "Notification of a field modification in the target VM. " |
| 2927 | "Requires canWatchFieldModification capability - see " |
| 2928 | "<a href=\"#JDWP_VirtualMachine_CapabilitiesNew\">CapabilitiesNew</a>." |
| 2929 | |
| 2930 | (int requestID "Request that generated event") |
| 2931 | (threadObject thread "Modifying thread") |
| 2932 | (location location "Location of modify") |
| 2933 | (byte refTypeTag "Kind of reference type. " |
| 2934 | "See <a href=\"#JDWP_TypeTag\">JDWP.TypeTag</a>") |
| 2935 | (referenceTypeID typeID "Type of field") |
| 2936 | (field fieldID "Field being modified") |
| 2937 | (tagged-object object |
| 2938 | "Object being modified (null=0 for statics") |
| 2939 | (value valueToBe "Value to be assigned") |
| 2940 | ) |
| 2941 | (Alt VMDeath=JDWP.EventKind.VM_DEATH |
| 2942 | (int requestID |
| 2943 | "Request that generated event") |
| 2944 | ) |
| 2945 | ) |
| 2946 | ) |
| 2947 | ) |
| 2948 | ) |
| 2949 | ) |
| 2950 | (ConstantSet Error |
| 2951 | (Constant NONE =0 "No error has occurred.") |
| 2952 | (Constant INVALID_THREAD =10 "Passed thread is null, is not a valid thread or has exited.") |
| 2953 | (Constant INVALID_THREAD_GROUP =11 "Thread group invalid.") |
| 2954 | (Constant INVALID_PRIORITY =12 "Invalid priority.") |
| 2955 | (Constant THREAD_NOT_SUSPENDED =13 "If the specified thread has not been " |
| 2956 | "suspended by an event.") |
| 2957 | (Constant THREAD_SUSPENDED =14 "Thread already suspended.") |
| 2958 | (Constant THREAD_NOT_ALIVE =15 "Thread has not been started or is now dead.") |
| 2959 | |
| 2960 | (Constant INVALID_OBJECT =20 "If this reference type has been unloaded " |
| 2961 | "and garbage collected.") |
| 2962 | (Constant INVALID_CLASS =21 "Invalid class.") |
| 2963 | (Constant CLASS_NOT_PREPARED =22 "Class has been loaded but not yet prepared.") |
| 2964 | (Constant INVALID_METHODID =23 "Invalid method.") |
| 2965 | (Constant INVALID_LOCATION =24 "Invalid location.") |
| 2966 | (Constant INVALID_FIELDID =25 "Invalid field.") |
| 2967 | (Constant INVALID_FRAMEID =30 "Invalid jframeID.") |
| 2968 | (Constant NO_MORE_FRAMES =31 "There are no more Java or JNI frames on the " |
| 2969 | "call stack.") |
| 2970 | (Constant OPAQUE_FRAME =32 "Information about the frame is not available.") |
| 2971 | (Constant NOT_CURRENT_FRAME =33 "Operation can only be performed on current frame.") |
| 2972 | (Constant TYPE_MISMATCH =34 "The variable is not an appropriate type for " |
| 2973 | "the function used.") |
| 2974 | (Constant INVALID_SLOT =35 "Invalid slot.") |
| 2975 | (Constant DUPLICATE =40 "Item already set.") |
| 2976 | (Constant NOT_FOUND =41 "Desired element not found.") |
| 2977 | (Constant INVALID_MONITOR =50 "Invalid monitor.") |
| 2978 | (Constant NOT_MONITOR_OWNER =51 "This thread doesn't own the monitor.") |
| 2979 | (Constant INTERRUPT =52 "The call has been interrupted before completion.") |
| 2980 | (Constant INVALID_CLASS_FORMAT =60 "The virtual machine attempted to read a class " |
| 2981 | "file and determined that the file is malformed " |
| 2982 | "or otherwise cannot be interpreted as a class file.") |
| 2983 | (Constant CIRCULAR_CLASS_DEFINITION |
| 2984 | =61 "A circularity has been detected while " |
| 2985 | "initializing a class.") |
| 2986 | (Constant FAILS_VERIFICATION =62 "The verifier detected that a class file, " |
| 2987 | "though well formed, contained some sort of " |
| 2988 | "internal inconsistency or security problem.") |
| 2989 | (Constant ADD_METHOD_NOT_IMPLEMENTED |
| 2990 | =63 "Adding methods has not been implemented.") |
| 2991 | (Constant SCHEMA_CHANGE_NOT_IMPLEMENTED |
| 2992 | =64 "Schema change has not been implemented.") |
| 2993 | (Constant INVALID_TYPESTATE =65 "The state of the thread has been modified, " |
| 2994 | "and is now inconsistent.") |
| 2995 | (Constant HIERARCHY_CHANGE_NOT_IMPLEMENTED |
| 2996 | =66 "A direct superclass is different for the new class " |
| 2997 | "version, or the set of directly implemented " |
| 2998 | "interfaces is different " |
| 2999 | "and canUnrestrictedlyRedefineClasses is false.") |
| 3000 | (Constant DELETE_METHOD_NOT_IMPLEMENTED |
| 3001 | =67 "The new class version does not declare a method " |
| 3002 | "declared in the old class version " |
| 3003 | "and canUnrestrictedlyRedefineClasses is false.") |
| 3004 | (Constant UNSUPPORTED_VERSION =68 "A class file has a version number not supported " |
| 3005 | "by this VM.") |
| 3006 | (Constant NAMES_DONT_MATCH =69 "The class name defined in the new class file is " |
| 3007 | "different from the name in the old class object.") |
| 3008 | (Constant CLASS_MODIFIERS_CHANGE_NOT_IMPLEMENTED |
| 3009 | =70 "The new class version has different modifiers and " |
| 3010 | "and canUnrestrictedlyRedefineClasses is false.") |
| 3011 | (Constant METHOD_MODIFIERS_CHANGE_NOT_IMPLEMENTED |
| 3012 | =71 "A method in the new class version has " |
| 3013 | "different modifiers " |
| 3014 | "than its counterpart in the old class version and " |
| 3015 | "and canUnrestrictedlyRedefineClasses is false.") |
| 3016 | (Constant NOT_IMPLEMENTED =99 "The functionality is not implemented in " |
| 3017 | "this virtual machine.") |
| 3018 | (Constant NULL_POINTER =100 "Invalid pointer.") |
| 3019 | (Constant ABSENT_INFORMATION =101 "Desired information is not available.") |
| 3020 | (Constant INVALID_EVENT_TYPE =102 "The specified event type id is not recognized.") |
| 3021 | (Constant ILLEGAL_ARGUMENT =103 "Illegal argument.") |
| 3022 | (Constant OUT_OF_MEMORY =110 "The function needed to allocate memory and " |
| 3023 | "no more memory was available for allocation.") |
| 3024 | (Constant ACCESS_DENIED =111 "Debugging has not been enabled in this " |
| 3025 | "virtual machine. JVMTI cannot be used.") |
| 3026 | (Constant VM_DEAD =112 "The virtual machine is not running.") |
| 3027 | (Constant INTERNAL =113 "An unexpected internal error has occurred.") |
| 3028 | (Constant UNATTACHED_THREAD =115 "The thread being used to call this function " |
| 3029 | "is not attached to the virtual machine. " |
| 3030 | "Calls must be made from attached threads.") |
| 3031 | (Constant INVALID_TAG =500 "object type id or class tag.") |
| 3032 | (Constant ALREADY_INVOKING =502 "Previous invoke not complete.") |
| 3033 | (Constant INVALID_INDEX =503 "Index is invalid.") |
| 3034 | (Constant INVALID_LENGTH =504 "The length is invalid.") |
| 3035 | (Constant INVALID_STRING =506 "The string is invalid.") |
| 3036 | (Constant INVALID_CLASS_LOADER =507 "The class loader is invalid.") |
| 3037 | (Constant INVALID_ARRAY =508 "The array is invalid.") |
| 3038 | (Constant TRANSPORT_LOAD =509 "Unable to load the transport.") |
| 3039 | (Constant TRANSPORT_INIT =510 "Unable to initialize the transport.") |
| 3040 | (Constant NATIVE_METHOD =511 ) |
| 3041 | (Constant INVALID_COUNT =512 "The count is invalid.") |
| 3042 | ) |
| 3043 | (ConstantSet EventKind |
| 3044 | (Constant SINGLE_STEP =1 ) |
| 3045 | (Constant BREAKPOINT =2 ) |
| 3046 | (Constant FRAME_POP =3 ) |
| 3047 | (Constant EXCEPTION =4 ) |
| 3048 | (Constant USER_DEFINED =5 ) |
| 3049 | (Constant THREAD_START =6 ) |
| 3050 | (Constant THREAD_DEATH =7 ) |
| 3051 | (Constant THREAD_END =7 "obsolete - was used in jvmdi") |
| 3052 | (Constant CLASS_PREPARE =8 ) |
| 3053 | (Constant CLASS_UNLOAD =9 ) |
| 3054 | (Constant CLASS_LOAD =10 ) |
| 3055 | (Constant FIELD_ACCESS =20 ) |
| 3056 | (Constant FIELD_MODIFICATION =21 ) |
| 3057 | (Constant EXCEPTION_CATCH =30 ) |
| 3058 | (Constant METHOD_ENTRY =40 ) |
| 3059 | (Constant METHOD_EXIT =41 ) |
| 3060 | (Constant METHOD_EXIT_WITH_RETURN_VALUE =42 ) |
| 3061 | (Constant MONITOR_CONTENDED_ENTER =43 ) |
| 3062 | (Constant MONITOR_CONTENDED_ENTERED =44 ) |
| 3063 | (Constant MONITOR_WAIT =45 ) |
| 3064 | (Constant MONITOR_WAITED =46 ) |
| 3065 | (Constant VM_START =90 ) |
| 3066 | (Constant VM_INIT =90 "obsolete - was used in jvmdi") |
| 3067 | (Constant VM_DEATH =99 ) |
| 3068 | (Constant VM_DISCONNECTED =100 "Never sent across JDWP") |
| 3069 | ) |
| 3070 | |
| 3071 | (ConstantSet ThreadStatus |
| 3072 | (Constant ZOMBIE =0 ) |
| 3073 | (Constant RUNNING =1 ) |
| 3074 | (Constant SLEEPING =2 ) |
| 3075 | (Constant MONITOR =3 ) |
| 3076 | (Constant WAIT =4 ) |
| 3077 | ) |
| 3078 | |
| 3079 | (ConstantSet SuspendStatus |
| 3080 | (Constant SUSPEND_STATUS_SUSPENDED = 0x1 ) |
| 3081 | ) |
| 3082 | (ConstantSet ClassStatus |
| 3083 | (Constant VERIFIED =1 ) |
| 3084 | (Constant PREPARED =2 ) |
| 3085 | (Constant INITIALIZED =4 ) |
| 3086 | (Constant ERROR =8 ) |
| 3087 | ) |
| 3088 | (ConstantSet TypeTag |
| 3089 | (Constant CLASS=1 "ReferenceType is a class. ") |
| 3090 | (Constant INTERFACE=2 "ReferenceType is an interface. ") |
| 3091 | (Constant ARRAY=3 "ReferenceType is an array. ") |
| 3092 | ) |
| 3093 | (ConstantSet Tag |
| 3094 | (Constant ARRAY = '[' "'[' - an array object (objectID size). ") |
| 3095 | (Constant BYTE = 'B' "'B' - a byte value (1 byte).") |
| 3096 | (Constant CHAR = 'C' "'C' - a character value (2 bytes).") |
| 3097 | (Constant OBJECT = 'L' "'L' - an object (objectID size).") |
| 3098 | (Constant FLOAT = 'F' "'F' - a float value (4 bytes).") |
| 3099 | (Constant DOUBLE = 'D' "'D' - a double value (8 bytes).") |
| 3100 | (Constant INT = 'I' "'I' - an int value (4 bytes).") |
| 3101 | (Constant LONG = 'J' "'J' - a long value (8 bytes).") |
| 3102 | (Constant SHORT = 'S' "'S' - a short value (2 bytes).") |
| 3103 | (Constant VOID = 'V' "'V' - a void value (no bytes).") |
| 3104 | (Constant BOOLEAN = 'Z' "'Z' - a boolean value (1 byte).") |
| 3105 | (Constant STRING = 's' "'s' - a String object (objectID size). ") |
| 3106 | (Constant THREAD = 't' "'t' - a Thread object (objectID size). ") |
| 3107 | (Constant THREAD_GROUP = 'g' |
| 3108 | "'g' - a ThreadGroup object (objectID size). ") |
| 3109 | (Constant CLASS_LOADER = 'l' |
| 3110 | "'l' - a ClassLoader object (objectID size). ") |
| 3111 | (Constant CLASS_OBJECT = 'c' |
| 3112 | "'c' - a class object object (objectID size). ") |
| 3113 | ) |
| 3114 | |
| 3115 | (ConstantSet StepDepth |
| 3116 | (Constant INTO = 0 |
| 3117 | "Step into any method calls that occur before the end of the step. ") |
| 3118 | (Constant OVER = 1 |
| 3119 | "Step over any method calls that occur before the end of the step. ") |
| 3120 | (Constant OUT = 2 |
| 3121 | "Step out of the current method. ") |
| 3122 | ) |
| 3123 | |
| 3124 | (ConstantSet StepSize |
| 3125 | (Constant MIN = 0 |
| 3126 | "Step by the minimum possible amount (often a bytecode instruction). ") |
| 3127 | (Constant LINE = 1 |
| 3128 | "Step to the next source line unless there is no line number information in which case a MIN step is done instead.") |
| 3129 | ) |
| 3130 | |
| 3131 | (ConstantSet SuspendPolicy |
| 3132 | (Constant NONE = 0 |
| 3133 | "Suspend no threads when this event is encountered. ") |
| 3134 | (Constant EVENT_THREAD = 1 |
| 3135 | "Suspend the event thread when this event is encountered. ") |
| 3136 | (Constant ALL = 2 |
| 3137 | "Suspend all threads when this event is encountered. ") |
| 3138 | ) |
| 3139 | |
| 3140 | (ConstantSet InvokeOptions |
| 3141 | "The invoke options are a combination of zero or more of the following bit flags:" |
| 3142 | (Constant INVOKE_SINGLE_THREADED = 0x01 |
| 3143 | "otherwise, all threads started. ") |
| 3144 | (Constant INVOKE_NONVIRTUAL = 0x02 |
| 3145 | "otherwise, normal virtual invoke (instance methods only)") |
| 3146 | ) |
| 3147 | |
| 3148 | |