com.facebook.stetho.dumpapp.plugins

Class HprofDumperPlugin

java.lang.Object

com.facebook.stetho.dumpapp.plugins.HprofDumperPlugin

All Implemented Interfaces:

DumperPlugin

public class HprofDumperPlugin
extends java.lang.Object
implements DumperPlugin

Generates an hprof on the sdcard and returns to the client the absolute path to the file.

For convenient usage, see: scripts/hprof_dump.sh

Constructor Summary

Constructors

Constructor and Description
HprofDumperPlugin(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	dump(DumperContext dumpContext) Invoked in response to the user running the dumpapp command and specifying your plugin.
java.lang.String	getName() Plugin name according to the dumpsys command-line interface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HprofDumperPlugin

public HprofDumperPlugin(android.content.Context context)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DumperPlugin

Plugin name according to the dumpsys command-line interface. Please be mindful of the fact that this is part of a command-line interface and should be generally easy to type and remember. Avoid underscores, capital letters, and plural names. Instead, prefer terse names like "network", "logging", etc.

Specified by:

getName in interface DumperPlugin

dump

public void dump(DumperContext dumpContext)
          throws DumpException

Description copied from interface: DumperPlugin

Invoked in response to the user running the dumpapp command and specifying your plugin.

Any output written to DumperContext.getStdout() will be displayed to the caller.

Specified by:

dump in interface DumperPlugin

Parameters:

dumpContext - Contains the command-line state (extra arguments, output channel, etc).

Throws:

DumpException - Your plugin can throw this event to easily bail from a dump sequence on unexpected errors. The message will be displayed directly to the caller and the dumpapp script will terminate with a non-successful exit code.