comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java @ 21972:ff6f34159b8a

Providing package-info for most of API packages. Feel free to provide your package-info.java for anything that has API in its name.
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Tue, 23 Jun 2015 12:44:41 +0200
parents 9c8c0937da41
children 5bc7f7b867ab
comparison
equal deleted inserted replaced
21971:60d7d22f9c56 21972:ff6f34159b8a
75 * <li>A Probe has a single source-based location in an AST, but manages a separate 75 * <li>A Probe has a single source-based location in an AST, but manages a separate
76 * <em>instrumentation chain</em> of Nodes at the equivalent location in each clone of the AST.</li> 76 * <em>instrumentation chain</em> of Nodes at the equivalent location in each clone of the AST.</li>
77 * <li>When a probed AST is cloned, the instrumentation chain associated with each Probe is cloned 77 * <li>When a probed AST is cloned, the instrumentation chain associated with each Probe is cloned
78 * along with the rest of the AST.</li> 78 * along with the rest of the AST.</li>
79 * 79 *
80 * <li>When a new Instrument (for example an instance of {@link SimpleInstrument} is attached to a 80 * <li>When a new Instrument (for example an instance created by
81 * Probe, the Instrument inserts a new instance of its private Node type, 81 * {@link Instrument#create(com.oracle.truffle.api.instrument.SimpleInstrumentListener, java.lang.String)}
82 * {@link SimpleInstrument.SimpleInstrumentNode}, into <em>each of the instrument chains</em> 82 * is attached to a Probe, the Instrument inserts a new instance of its private Node type into
83 * managed by the Probe, i.e. one node instance per existing clone of the AST.</li> 83 * <em>each of the instrument chains</em> managed by the Probe, i.e. one node instance per existing
84 * clone of the AST.</li>
84 * 85 *
85 * <li>If an Instrument is attached to a Probe in an AST that subsequently gets cloned, then the 86 * <li>If an Instrument is attached to a Probe in an AST that subsequently gets cloned, then the
86 * Instrument's private Node type will be cloned along with the rest of the the AST.</li> 87 * Instrument's private Node type will be cloned along with the rest of the the AST.</li>
87 * <li>Each Instrument's private Node type is a dynamic inner class whose only state is in the 88 * <li>Each Instrument's private Node type is a dynamic inner class whose only state is in the
88 * shared (outer) Instrument instance; that state includes a reference to the Instrument's listener. 89 * shared (outer) Instrument instance; that state includes a reference to the Instrument's listener.