javax.tools.diagnostics.vm.spi.delegates
Class JavaDumpDelegate

java.lang.Object
  extended by javax.tools.diagnostics.vm.spi.delegates.JavaDumpDelegate
All Implemented Interfaces:
DumpInitiatorDelegate

public class JavaDumpDelegate
extends java.lang.Object
implements DumpInitiatorDelegate


Constructor Summary
JavaDumpDelegate()
           
 
Method Summary
 boolean available()
          Called to check that the delegate has all available resources to proceed.
 DumpHandle createDumpHandle()
          Returns a Dump handle for a default configured dump
 DumpHandle createDumpHandle(DumpDescriptor descriptor)
          Returns a Dump handle for a dump that will match the provided descriptor on a "best can do" basis.
 DumpInitiatorCapabilities getCapabilities()
          Returns an object that describes the capabilities offered by this initiator
 java.lang.String getDumpType()
          Returns a literal that describes the dump being produced by this initiator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavaDumpDelegate

public JavaDumpDelegate()
Method Detail

available

public boolean available()
Description copied from interface: DumpInitiatorDelegate
Called to check that the delegate has all available resources to proceed. This method should only be called by the Dump class This method will always be called before the first call to dump

Specified by:
available in interface DumpInitiatorDelegate
Returns:
true if the delegate is available

createDumpHandle

public DumpHandle createDumpHandle()
Description copied from interface: DumpInitiatorDelegate
Returns a Dump handle for a default configured dump

Specified by:
createDumpHandle in interface DumpInitiatorDelegate
Returns:
valid dump handle

createDumpHandle

public DumpHandle createDumpHandle(DumpDescriptor descriptor)
Description copied from interface: DumpInitiatorDelegate
Returns a Dump handle for a dump that will match the provided descriptor on a "best can do" basis.

Specified by:
createDumpHandle in interface DumpInitiatorDelegate
Returns:
valid dump handle

getCapabilities

public DumpInitiatorCapabilities getCapabilities()
Description copied from interface: DumpInitiatorDelegate
Returns an object that describes the capabilities offered by this initiator

Specified by:
getCapabilities in interface DumpInitiatorDelegate
Returns:
a populated capabilities object

getDumpType

public java.lang.String getDumpType()
Description copied from interface: DumpInitiatorDelegate
Returns a literal that describes the dump being produced by this initiator. The value can be used by callers to the DumpFactory API to retrieve a specific dump initiator.

Specified by:
getDumpType in interface DumpInitiatorDelegate
Returns:
dump type literal


Copyright © 2010. All Rights Reserved.