comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumenter.java @ 22230:3f2052afcb6d

Truffle/Instrumentation: rename the methods in the Instrument listener classes to use the "on" convention, e.g. onEnter(), add Javadoc
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 20 Sep 2015 16:48:50 -0700
parents c896a8e70777
children 59e022cee529
comparison
equal deleted inserted replaced
22229:a4ac9f2ff2bf 22230:3f2052afcb6d
309 } 309 }
310 310
311 /** 311 /**
312 * <em>Attaches</em> a {@link SimpleInstrumentListener listener} to a {@link Probe}, creating a 312 * <em>Attaches</em> a {@link SimpleInstrumentListener listener} to a {@link Probe}, creating a
313 * <em>binding</em> called an {@link Instrument}. Until the Instrument is 313 * <em>binding</em> called an {@link Instrument}. Until the Instrument is
314 * {@linkplain Instrument#dispose() disposed}, it routes notification of 314 * {@linkplain Instrument#dispose() disposed}, it routes synchronous notification of
315 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to 315 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to
316 * the listener. 316 * the listener.
317 * 317 *
318 * @param probe source of execution events 318 * @param probe source of execution events
319 * @param listener receiver of execution events 319 * @param listener receiver of execution events
328 } 328 }
329 329
330 /** 330 /**
331 * <em>Attaches</em> a {@link StandardInstrumentListener listener} to a {@link Probe}, creating 331 * <em>Attaches</em> a {@link StandardInstrumentListener listener} to a {@link Probe}, creating
332 * a <em>binding</em> called an {@link Instrument}. Until the Instrument is 332 * a <em>binding</em> called an {@link Instrument}. Until the Instrument is
333 * {@linkplain Instrument#dispose() disposed}, it routes notification of 333 * {@linkplain Instrument#dispose() disposed}, it routes synchronous notification of
334 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to 334 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to
335 * the listener. 335 * the listener.
336 * 336 *
337 * @param probe source of execution events 337 * @param probe source of execution events
338 * @param listener receiver of execution events 338 * @param listener receiver of execution events
347 } 347 }
348 348
349 /** 349 /**
350 * <em>Attaches</em> a {@link AdvancedInstrumentResultListener listener} to a {@link Probe}, 350 * <em>Attaches</em> a {@link AdvancedInstrumentResultListener listener} to a {@link Probe},
351 * creating a <em>binding</em> called an {@link Instrument}. Until the Instrument is 351 * creating a <em>binding</em> called an {@link Instrument}. Until the Instrument is
352 * {@linkplain Instrument#dispose() disposed}, it routes notification of 352 * {@linkplain Instrument#dispose() disposed}, it routes synchronous notification of
353 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to 353 * {@linkplain EventHandlerNode execution events} taking place at the Probe's AST location to
354 * the listener. 354 * the listener.
355 * <p> 355 * <p>
356 * This Instrument executes efficiently, subject to full Truffle optimization, a client-provided 356 * This Instrument executes efficiently, subject to full Truffle optimization, a client-provided
357 * AST fragment every time the Probed node is entered. 357 * AST fragment every time the Probed node is entered.