Enhancements to remove hidden exceptions in experiments lifecycles

- addition of several debug messages to track the problems on macOS
related to disappearing icons, blank views, etc.

msi.gama.core/src/msi/gama/common/interfaces/IGamaView.java

@@ -1,9 +1,8 @@
 /*******************************************************************************************************
  *
- * msi.gama.common.interfaces.IGamaView.java, in plugin msi.gama.core, is part of the source code of the GAMA modeling
- * and simulation platform (v. 1.8.1)
+ * IGamaView.java, in msi.gama.core, is part of the source code of the GAMA modeling and simulation platform (v.1.8.2).
  *
- * (c) 2007-2020 UMI 209 UMMISCO IRD/SU & Partners
+ * (c) 2007-2021 UMI 209 UMMISCO IRD/SU & Partners (IRIT, MIAT, TLU, CTU)
  *
  * Visit https://github.com/gama-platform/gama for license information and contacts.
  *
@@ -31,96 +30,293 @@
  */
 public interface IGamaView {
 
+	/**
+	 * Update.
+	 *
+	 * @param output
+	 *            the output
+	 */
 	void update(IDisplayOutput output);
 
+	/**
+	 * Adds the output.
+	 *
+	 * @param output
+	 *            the output
+	 */
 	void addOutput(IDisplayOutput output);
 
+	/**
+	 * Removes the output.
+	 *
+	 * @param putput
+	 *            the putput
+	 */
 	void removeOutput(IDisplayOutput putput);
 
+	/**
+	 * Gets the output.
+	 *
+	 * @return the output
+	 */
 	IDisplayOutput getOutput();
 
+	/**
+	 * Close.
+	 *
+	 * @param scope
+	 *            the scope
+	 */
 	void close(IScope scope);
 
+	/**
+	 * Change part name with simulation.
+	 *
+	 * @param agent
+	 *            the agent
+	 */
 	void changePartNameWithSimulation(SimulationAgent agent);
 
+	/**
+	 * Reset.
+	 */
 	void reset();
 
+	/**
+	 * Gets the part name.
+	 *
+	 * @return the part name
+	 */
 	String getPartName();
 
+	/**
+	 * Sets the name.
+	 *
+	 * @param name
+	 *            the new name
+	 */
 	void setName(String name);
 
+	/**
+	 * Update toolbar state.
+	 */
 	void updateToolbarState();
 
+	/**
+	 * Hide toolbar.
+	 */
+	void hideToolbar();
+
+	/**
+	 * Show toolbar.
+	 */
+	void showToolbar();
+
+	/**
+	 * The Interface Test.
+	 */
 	public interface Test {
+
+		/**
+		 * Adds the test result.
+		 *
+		 * @param summary
+		 *            the summary
+		 */
 		void addTestResult(final CompoundSummary<?, ?> summary);
 
+		/**
+		 * Start new test sequence.
+		 *
+		 * @param all
+		 *            the all
+		 */
 		void startNewTestSequence(boolean all);
 
+		/**
+		 * Display progress.
+		 *
+		 * @param number
+		 *            the number
+		 * @param total
+		 *            the total
+		 */
 		void displayProgress(int number, int total);
 
+		/**
+		 * Finish test sequence.
+		 */
 		void finishTestSequence();
 
 	}
 
+	/**
+	 * The Interface Display.
+	 */
 	public interface Display extends IGamaView {
 
+		/**
+		 * Contains point.
+		 *
+		 * @param x
+		 *            the x
+		 * @param y
+		 *            the y
+		 * @return true, if successful
+		 */
 		boolean containsPoint(int x, int y);
 
+		/**
+		 * Gets the display surface.
+		 *
+		 * @return the display surface
+		 */
 		IDisplaySurface getDisplaySurface();
 
+		/**
+		 * Toggle full screen.
+		 */
 		void toggleFullScreen();
 
+		/**
+		 * Checks if is full screen.
+		 *
+		 * @return true, if is full screen
+		 */
 		boolean isFullScreen();
 
+		/**
+		 * Toggle side controls.
+		 */
 		void toggleSideControls();
 
+		/**
+		 * Toggle overlay.
+		 */
 		void toggleOverlay();
 
+		/**
+		 * Show overlay.
+		 */
 		void showOverlay();
 
+		/**
+		 * Hide overlay.
+		 */
 		void hideOverlay();
 
-		void hideToolbar();
-
-		void showToolbar();
-
+		/**
+		 * Gets the output.
+		 *
+		 * @return the output
+		 */
 		@Override
 		LayeredDisplayOutput getOutput();
 
+		/**
+		 * Gets the index.
+		 *
+		 * @return the index
+		 */
 		int getIndex();
 
+		/**
+		 * Sets the index.
+		 *
+		 * @param i
+		 *            the new index
+		 */
 		void setIndex(int i);
 
-		default List<String> getCameraNames() {
-			return Collections.EMPTY_LIST;
-		}
+		/**
+		 * Gets the camera names.
+		 *
+		 * @return the camera names
+		 */
+		default List<String> getCameraNames() { return Collections.EMPTY_LIST; }
 
+		/**
+		 * Take snapshot.
+		 */
 		void takeSnapshot();
 	}
 
+	/**
+	 * The Interface Error.
+	 */
 	public interface Error {
 
+		/**
+		 * Display errors.
+		 */
 		void displayErrors();
 
 	}
 
+	/**
+	 * The Interface Html.
+	 */
 	public interface Html {
+
+		/**
+		 * Sets the url.
+		 *
+		 * @param url
+		 *            the new url
+		 */
 		void setUrl(String url);
 	}
 
+	/**
+	 * The Interface Parameters.
+	 */
 	public interface Parameters {
+
+		/**
+		 * Adds the item.
+		 *
+		 * @param exp
+		 *            the exp
+		 */
 		void addItem(IExperimentPlan exp);
 
+		/**
+		 * Update item values.
+		 */
 		void updateItemValues();
 	}
 
+	/**
+	 * The Interface Console.
+	 */
 	public interface Console {
 
+		/**
+		 * Append.
+		 *
+		 * @param msg
+		 *            the msg
+		 * @param root
+		 *            the root
+		 * @param color
+		 *            the color
+		 */
 		void append(String msg, ITopLevelAgent root, GamaColor color);
 
 	}
 
+	/**
+	 * The Interface User.
+	 */
 	public interface User {
+		/**
+		 * Inits the for.
+		 *
+		 * @param scope
+		 *            the scope
+		 * @param panel
+		 *            the panel
+		 */
 		void initFor(final IScope scope, final UserPanelStatement panel);
 	}