| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="ISO-8859-1" ?>
|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 4 | <head>
|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
|
| 6 | <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
|
| Marc R. Hoffmann | d7d2f75 | 2010-05-06 21:12:31 +0000 | [diff] [blame] | 7 | <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 8 | <title>JaCoCo - API Usage Examples</title>
|
| 9 | </head>
|
| Marc R. Hoffmann | d7d2f75 | 2010-05-06 21:12:31 +0000 | [diff] [blame] | 10 | <body>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 11 |
|
| 12 | <div class="breadcrumb">
|
| Marc R. Hoffmann | d7d2f75 | 2010-05-06 21:12:31 +0000 | [diff] [blame] | 13 | <a href="../index.html" class="el_report">JaCoCo</a> >
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 14 | <a href="index.html" class="el_group">Documentation</a> >
|
| 15 | <span class="el_source">API Usage Examples</span>
|
| 16 | </div>
|
| 17 | <div id="content">
|
| 18 |
|
| 19 | <h1>API Usage Examples</h1>
|
| 20 |
|
| 21 | <p>
|
| 22 | To get familiar with the API these examples demonstrate different aspects of
|
| 23 | the JaCoCo API. Each example can be separately compiled and executed as a Java
|
| 24 | main program. Some examples require additional command line arguments.
|
| 25 | </p>
|
| 26 |
|
| 27 | <table class="coverage">
|
| 28 | <thead>
|
| 29 | <tr>
|
| 30 | <td>File</td>
|
| 31 | <td>Description</td>
|
| 32 | </tr>
|
| 33 | </thead>
|
| 34 | <tbody>
|
| 35 | <tr>
|
| Marc R. Hoffmann | 6fd10ff | 2010-06-02 21:42:25 +0000 | [diff] [blame] | 36 | <td><a class="el_source" href="examples/java/CoreTutorial.java">CoreTutorial.java</a></td>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 37 | <td>This tutorial-like example instruments, executes and analyzes a single
|
| 38 | target class. Finally line coverage information is printed to the
|
| 39 | console.
|
| 40 | </td>
|
| 41 | </tr>
|
| 42 | <tr>
|
| Marc R. Hoffmann | 6fd10ff | 2010-06-02 21:42:25 +0000 | [diff] [blame] | 43 | <td><a class="el_source" href="examples/java/ClassInfo.java">ClassInfo.java</a></td>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 44 | <td>This example writes JaCoCo specific information for given Java class
|
| 45 | files.
|
| 46 | </td>
|
| 47 | </tr>
|
| 48 | <tr>
|
| Marc R. Hoffmann | 6fd10ff | 2010-06-02 21:42:25 +0000 | [diff] [blame] | 49 | <td><a class="el_source" href="examples/java/ExecDump.java">ExecDump.java</a></td>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 50 | <td>Utility to dump the content of execution data files in readable form.
|
| 51 | </td>
|
| 52 | </tr>
|
| Marc R. Hoffmann | 7428036 | 2010-05-18 16:47:18 +0000 | [diff] [blame] | 53 | <tr>
|
| Evgeny Mandrikov | a95de88 | 2011-06-23 12:04:20 +0000 | [diff] [blame] | 54 | <td><a class="el_source" href="examples/java/MBeanClient.java">MBeanClient.java</a></td>
|
| 55 | <td>This example connects to a coverage agent to collect execution data
|
| 56 | over the JMX.
|
| 57 | </td>
|
| 58 | </tr>
|
| 59 | <tr>
|
| Marc R. Hoffmann | 5385417 | 2010-06-02 22:01:37 +0000 | [diff] [blame] | 60 | <td><a class="el_source" href="examples/java/ExecutionDataClient.java">ExecutionDataClient.java</a></td>
|
| 61 | <td>This example connects to a coverage agent to collect execution data
|
| Evgeny Mandrikov | a95de88 | 2011-06-23 12:04:20 +0000 | [diff] [blame] | 62 | over the remote protocol.
|
| Marc R. Hoffmann | 7428036 | 2010-05-18 16:47:18 +0000 | [diff] [blame] | 63 | </td>
|
| 64 | </tr>
|
| Marc R. Hoffmann | 5385417 | 2010-06-02 22:01:37 +0000 | [diff] [blame] | 65 | <tr>
|
| 66 | <td><a class="el_source" href="examples/java/ExecutionDataServer.java">ExecutionDataServer.java</a></td>
|
| 67 | <td>This example starts a socket server to collect execution data from
|
| Evgeny Mandrikov | a95de88 | 2011-06-23 12:04:20 +0000 | [diff] [blame] | 68 | agents over the remote protocol.
|
| Marc R. Hoffmann | 5385417 | 2010-06-02 22:01:37 +0000 | [diff] [blame] | 69 | </td>
|
| 70 | </tr>
|
| Brock Janiczak | 3e59727 | 2011-03-02 10:12:31 +0000 | [diff] [blame] | 71 | <tr>
|
| 72 | <td><a class="el_source" href="examples/java/ReportGenerator.java">ReportGenerator.java</a></td>
|
| 73 | <td>This example generates HTML reports based on a simple project layout and well known execution
|
| 74 | data store file name.</td>
|
| 75 | </tr>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 76 | </tbody>
|
| 77 | </table>
|
| 78 |
|
| 79 |
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 80 | </div>
|
| 81 | <div class="footer">
|
| Marc R. Hoffmann | b623ffb | 2010-05-06 19:48:08 +0000 | [diff] [blame] | 82 | <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
|
| Marc R. Hoffmann | 52a97c5 | 2010-05-06 10:52:19 +0000 | [diff] [blame] | 83 | <a href="license.html">Copyright</a> © @copyright.years@ Mountainminds GmbH & Co. KG and Contributors
|
| 84 | </div>
|
| 85 |
|
| 86 | </body>
|
| 87 | </html> |