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