# HG changeset patch
# User Christian Humer <christian.humer@gmail.com>
# Date 1415211034 -3600
# Node ID b6c5647397100013e1b84268e1cd816fb0ce8fec
# Parent  2a604849b3e6e16f106cd9e440e9992972977f26
Truffle: added javadoc to GraalTruffleCompilationListener

diff -r 2a604849b3e6 -r b6c564739710 graal/com.oracle.graal.truffle/src/com/oracle/graal/truffle/GraalTruffleCompilationListener.java
--- a/graal/com.oracle.graal.truffle/src/com/oracle/graal/truffle/GraalTruffleCompilationListener.java	Thu Nov 06 11:29:39 2014 +0100
+++ b/graal/com.oracle.graal.truffle/src/com/oracle/graal/truffle/GraalTruffleCompilationListener.java	Wed Nov 05 19:10:34 2014 +0100
@@ -25,17 +25,48 @@
 import com.oracle.graal.api.code.*;
 import com.oracle.graal.nodes.*;
 import com.oracle.truffle.api.*;
+import com.oracle.truffle.api.nodes.*;
 
+/**
+ * Enables implementations of this interface to listen to compilation related events of the Graal
+ * Truffle runtime. The states for a particular {@link OptimizedCallTarget} that is compiled using
+ * the Graal Truffle system can be described using the following deterministic automata: * <code>
+ * <pre>
+ * ( (split | (queue . unqueue))*
+ *    . queue . started
+ *    . (truffleTierFinished . graalTierFinished . success)
+ *      | ([truffleTierFinished] . [graalTierFinished] . failed)
+ *    . invalidate )*
+ * </pre>
+ * </code>
+ * <p>
+ * Note: <code>|</code> is the 'or' and <code>.</code> is the sequential operator. The
+ * <code>*</code> represents the Kleene Closure.
+ * </p>
+ *
+ * @see GraalTruffleRuntime#addCompilationListener(GraalTruffleCompilationListener)
+ */
 public interface GraalTruffleCompilationListener {
 
+    void notifyCompilationSplit(OptimizedDirectCallNode callNode);
+
+    /**
+     * Invoked if a call target was queued to the compilation queue.
+     */
     void notifyCompilationQueued(OptimizedCallTarget target);
 
+    /**
+     * Invoked if a call target was unqueued from the compilation queue.
+     *
+     * @param source the source object that caused the compilation to be unqueued. For example the
+     *            source {@link Node} object. May be <code>null</code>.
+     * @param reason a textual description of the reason why the compilation was unqueued. May be
+     *            <code>null</code>.
+     */
     void notifyCompilationDequeued(OptimizedCallTarget target, Object source, CharSequence reason);
 
     void notifyCompilationFailed(OptimizedCallTarget target, StructuredGraph graph, Throwable t);
 
-    void notifyCompilationSplit(OptimizedDirectCallNode callNode);
-
     void notifyCompilationStarted(OptimizedCallTarget target);
 
     void notifyCompilationTruffleTierFinished(OptimizedCallTarget target, StructuredGraph graph);
@@ -44,8 +75,19 @@
 
     void notifyCompilationSuccess(OptimizedCallTarget target, StructuredGraph graph, CompilationResult result);
 
+    /**
+     * Invoked if a compiled call target was invalidated.
+     *
+     * @param source the source object that caused the compilation to be invalidated. For example
+     *            the source {@link Node} object. May be <code>null</code>.
+     * @param reason a textual description of the reason why the compilation was invalidated. May be
+     *            <code>null</code>.
+     */
     void notifyCompilationInvalidated(OptimizedCallTarget target, Object source, CharSequence reason);
 
+    /**
+     * Invoked as the compiler gets shut down.
+     */
     void notifyShutdown(TruffleRuntime runtime);
 
 }