README.md

If you want to create plugin for HeapStats Analyzer v2.1 or earlier, please see for2.2 branch.

SamplePlugin

Sample plugin for HeapStats Analyzer to use as template project.

Build

$ mvn package

How to use

1. Move sample plugin jar to lib in HeapStats Analyzer

$ mv target/heapstats-analyzer-plugin-sample.jar /path/to/HeapStatsAnalyzer/lib/
$ vim /path/to/HeapStatsAnalyzer/heapstats.properties

2. Set plugin FQCN to plugin entry as below:

plugins=jp.co.ntt.oss.heapstats.plugin.sample

3. run HeapStats Analyzer

How to create your plugin

HeapStats Analyzer provides a tab window per controllers (plugins) as below.

You can create your plugin by the below steps.

1. Create a Controller class which is extended jp.co.ntt.oss.heapstats.plugin.PluginController like SampleMainController.java.
2. Create FXML and CSS file to design your view.

• Example: src/main/resources/../sample

Tips: Run your plugin as standalone

If you want to run your plugin as standalone, you need

• a main class to launch your plugin.
• For example, sample plugin includes main class (SamplePlugin.java)
• to set heapstats-analyzer.jar in the classpath
• java -cp .:/path/to/heapstats-analyzer.jar:/path/to/yourplugin.jar <MainClass>

Tips: Separate Controller

If you want to separate your big controller and FXML file, you can separate the nested FXML file like sample plugin.

• MainController
• TabController

See also Oracle's documentation.

How to enable your plugin

You can enable your plugin by below steps.

1. Set your plugin ( *.jar ) to lib directory of HeapStats Analyzer.
2. Edit plugins properties in heapstats.properties to add a package of your Controller.