content/builds/3.0.0/apidocs/org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html - openjpa-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="it">
 <head>
 <!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:03 CEST 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>InstrumentationProvider (OpenJPA Parent POM 3.0.0 API)</title>
 <meta name="date" content="2018-06-14">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="InstrumentationProvider (OpenJPA Parent POM 3.0.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/InstrumentationProvider.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top">Frames</a></li>
 <li><a href="InstrumentationProvider.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.openjpa.lib.instrumentation</div>
 <h2 title="Interface InstrumentationProvider" class="title">Interface InstrumentationProvider</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a>, <a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html" title="class in org.apache.openjpa.instrumentation.jmx">JMXProvider</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">InstrumentationProvider</span></pre>
 <div class="block">Pluggable instrumentation providers (ex. JMX) must implement this interface. It
  provides methods for controlling the provider and the instruments instrumented
  by the provider.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#addInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">addInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</code>
 <div class="block">Adds an instrument to this providers list of managed instruments.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getConfiguration--">getConfiguration</a></span>()</code>
 <div class="block">Gets the configuration associated with the instrumentation provider</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrument--">getInstrument</a></span>()</code>
 <div class="block">Returns the string-based list of instruments directly configured by
  this provider via setInstrument.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases--">getInstrumentAliases</a></span>()</code>
 <div class="block">Returns an string array of identifier to class name aliases for
  instruments known to the instrumentation provider.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentByName-java.lang.String-">getInstrumentByName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
 <div class="block">Returns an instrument instrumented by this provider by name</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstruments--">getInstruments</a></span>()</code>
 <div class="block">Gets all instruments instrumented by this provider</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getOptions--">getOptions</a></span>()</code>
 <div class="block">Gets configuration options for this provider</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument-org.apache.openjpa.lib.instrumentation.Instrument-java.lang.Object-">initializeInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
                     <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</code>
 <div class="block">Initializes an instrument within the provided context.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument-org.apache.openjpa.lib.instrumentation.Instrument-java.lang.String-java.lang.Object-">initializeInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
                     <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options,
                     <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</code>
 <div class="block">Initializes an instrument within the provided options and context.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#isStarted--">isStarted</a></span>()</code>
 <div class="block">Whether the instrumentation provider started</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#removeInstrumentByName-java.lang.String-">removeInstrumentByName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
 <div class="block">Removes an instrument instrumented by this provider by name</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setInstrument-java.lang.String-">setInstrument</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;instruments)</code>
 <div class="block">Used to associate one or more instruments to a provider.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setOptions-java.lang.String-">setOptions</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options)</code>
 <div class="block">Sets configuration options for this provider</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start--">start</a></span>()</code>
 <div class="block">Stops the instrumentation provider</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">startInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</code>
 <div class="block">Starts an instrument</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstruments-org.apache.openjpa.lib.instrumentation.InstrumentationLevel-java.lang.Object-">startInstruments</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;level,
                 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</code>
 <div class="block">Starts all instruments of the specified instrumentation level and context.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stop--">stop</a></span>()</code>
 <div class="block">Starts the instrumentation provider</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">stopInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</code>
 <div class="block">Stops an instrument</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument-org.apache.openjpa.lib.instrumentation.Instrument-boolean-">stopInstrument</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
               boolean&nbsp;force)</code>
 <div class="block">Stops an instrument, forcing the stop, if necessary.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstruments-org.apache.openjpa.lib.instrumentation.InstrumentationLevel-java.lang.Object-">stopInstruments</a></span>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;level,
                <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</code>
 <div class="block">Stops all instruments of the specified instrumentation level and context.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="isStarted--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isStarted</h4>
 <pre>boolean&nbsp;isStarted()</pre>
 <div class="block">Whether the instrumentation provider started</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the provider is started</dd>
 </dl>
 </li>
 </ul>
 <a name="stop--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>stop</h4>
 <pre>void&nbsp;stop()</pre>
 <div class="block">Starts the instrumentation provider</div>
 </li>
 </ul>
 <a name="start--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>start</h4>
 <pre>void&nbsp;start()</pre>
 <div class="block">Stops the instrumentation provider</div>
 </li>
 </ul>
 <a name="getConfiguration--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getConfiguration</h4>
 <pre><a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a>&nbsp;getConfiguration()</pre>
 <div class="block">Gets the configuration associated with the instrumentation provider</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the configuration associated with the provider</dd>
 </dl>
 </li>
 </ul>
 <a name="setInstrument-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setInstrument</h4>
 <pre>void&nbsp;setInstrument(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;instruments)</pre>
 <div class="block">Used to associate one or more instruments to a provider.  Instruments
  are specified by class name or alias.  Multiple instruments must be
  specified as a comma separated list.

  example:  DataCache,QueryCache,com.my.MyInstrument
    where DataCache and QueryCache have aliases and com.my.MyInstrument is
    a class implementing an Instrument.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instruments</code> - one or more instrument class names or aliases</dd>
 </dl>
 </li>
 </ul>
 <a name="getInstrument--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInstrument</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getInstrument()</pre>
 <div class="block">Returns the string-based list of instruments directly configured by
  this provider via setInstrument.</div>
 </li>
 </ul>
 <a name="setOptions-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setOptions</h4>
 <pre>void&nbsp;setOptions(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options)</pre>
 <div class="block">Sets configuration options for this provider</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>options</code> - </dd>
 </dl>
 </li>
 </ul>
 <a name="getOptions--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getOptions</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getOptions()</pre>
 <div class="block">Gets configuration options for this provider</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>options</code> - </dd>
 </dl>
 </li>
 </ul>
 <a name="getInstrumentAliases--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInstrumentAliases</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getInstrumentAliases()</pre>
 <div class="block">Returns an string array of identifier to class name aliases for
  instruments known to the instrumentation provider.  Example:

   {"DataCache", "org.apache.openjpa.instrumentation.DataCacheInstrument",
    "QueryCache", "org.apache.openjpa.instrumentation.QueryCacheInstrument"}</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a string array of identifier, class name pairs.</dd>
 </dl>
 </li>
 </ul>
 <a name="addInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addInstrument</h4>
 <pre>void&nbsp;addInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
 <div class="block">Adds an instrument to this providers list of managed instruments.  The
  instrument will participate in context-based lifecycle routines,
  depending on the instrumentation level.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - </dd>
 </dl>
 </li>
 </ul>
 <a name="stopInstruments-org.apache.openjpa.lib.instrumentation.InstrumentationLevel-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>stopInstruments</h4>
 <pre>void&nbsp;stopInstruments(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;level,
                      <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</pre>
 <div class="block">Stops all instruments of the specified instrumentation level and context.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>level</code> - instrumentation level</dd>
 <dd><code>context</code> - instrumentation context (factory, broker, config)</dd>
 </dl>
 </li>
 </ul>
 <a name="startInstruments-org.apache.openjpa.lib.instrumentation.InstrumentationLevel-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>startInstruments</h4>
 <pre>void&nbsp;startInstruments(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;level,
                       <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</pre>
 <div class="block">Starts all instruments of the specified instrumentation level and context.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>level</code> - instrumentation level</dd>
 <dd><code>context</code> - instrumentation context (factory, broker, config)</dd>
 </dl>
 </li>
 </ul>
 <a name="initializeInstrument-org.apache.openjpa.lib.instrumentation.Instrument-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>initializeInstrument</h4>
 <pre>void&nbsp;initializeInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
                           <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</pre>
 <div class="block">Initializes an instrument within the provided context.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - an instrument</dd>
 <dd><code>context</code> - instrumentation context (factory, broker, config)</dd>
 </dl>
 </li>
 </ul>
 <a name="initializeInstrument-org.apache.openjpa.lib.instrumentation.Instrument-java.lang.String-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>initializeInstrument</h4>
 <pre>void&nbsp;initializeInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
                           <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options,
                           <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context)</pre>
 <div class="block">Initializes an instrument within the provided options and context.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - an instrument</dd>
 <dd><code>options</code> - configuration options to provide the instrument during initialization</dd>
 <dd><code>context</code> - instrumentation context (factory, broker, config)</dd>
 </dl>
 </li>
 </ul>
 <a name="getInstrumentByName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInstrumentByName</h4>
 <pre><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;getInstrumentByName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
 <div class="block">Returns an instrument instrumented by this provider by name</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the instrument to return</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the instrument or null if not instrumented by this provider</dd>
 </dl>
 </li>
 </ul>
 <a name="removeInstrumentByName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removeInstrumentByName</h4>
 <pre>void&nbsp;removeInstrumentByName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
 <div class="block">Removes an instrument instrumented by this provider by name</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the instrument to remove</dd>
 </dl>
 </li>
 </ul>
 <a name="getInstruments--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInstruments</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&gt;&nbsp;getInstruments()</pre>
 <div class="block">Gets all instruments instrumented by this provider</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>instruments instrumented by this provider</dd>
 </dl>
 </li>
 </ul>
 <a name="startInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>startInstrument</h4>
 <pre>void&nbsp;startInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
 <div class="block">Starts an instrument</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - this instrument to start</dd>
 </dl>
 </li>
 </ul>
 <a name="stopInstrument-org.apache.openjpa.lib.instrumentation.Instrument-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>stopInstrument</h4>
 <pre>void&nbsp;stopInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
 <div class="block">Stops an instrument</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - the instrument to stop</dd>
 </dl>
 </li>
 </ul>
 <a name="stopInstrument-org.apache.openjpa.lib.instrumentation.Instrument-boolean-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>stopInstrument</h4>
 <pre>void&nbsp;stopInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
                     boolean&nbsp;force)</pre>
 <div class="block">Stops an instrument, forcing the stop, if necessary.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>instrument</code> - the instrument to stop</dd>
 <dd><code>force</code> - forces the stop if the instrument does not stop gracefully.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/InstrumentationProvider.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top">Frames</a></li>
 <li><a href="InstrumentationProvider.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>