tmf: Add a ITmfStateSystem.waitUntilBuilt() method with timeout

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / statesystem / ITmfStateSystem.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystem.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystem.java
index 99cd49f964363898ab78c1f09f4cbba046b2b3cb..d4a8dadae456ab29c01d505ed87e7c4fb8998625 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystem.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystem.java
@@ -75,6 +75,26 @@ public interface ITmfStateSystem {
      */
     void waitUntilBuilt();
 
+    /**
+     * Wait until the state system construction is finished. Similar to
+     * {@link #waitUntilBuilt()}, but we also specify a timeout. If the timeout
+     * elapses before the construction is finished, the method will return.
+     *
+     * The return value determines if the return was due to the construction
+     * finishing (true), or the timeout elapsing (false).
+     *
+     * This can be useful, for example, for a component doing queries
+     * periodically to the system while it is being built.
+     *
+     * @param timeout
+     *            Timeout value in milliseconds
+     * @return True if the return was due to the construction finishing, false
+     *         if it was because the timeout elapsed. Same logic as
+     *         {@link java.util.concurrent.CountDownLatch#await(long, java.util.concurrent.TimeUnit)}
+     * @since 3.0
+     */
+    boolean waitUntilBuilt(long timeout);
+
     /**
      * Notify the state system that the trace is being closed, so it should
      * clean up, close its files, etc.