Merge branch 'release/1-2-0'

Author: remikey

CHANGELOG.md

@@ -4,7 +4,160 @@ This file lists modifications introduced by each version.
 
 ## [Unreleased]
 
-* empty
+* Empty
+
+## [1.2.0] - 2020/02/12
+
+###  ClockManager class modifications
+
+**Bug fixes in ClockManager:**
+
+[[issue 86]][issue: #86]
+
+* The modification of the `ClockManager`'s internal time value (the one actually used by the `Topology`) now coincides 
+  with the ticking of the `Clock`
+  
+  Now, the clock is first incremented and then the `Scheduler` is called. 
+  It was previously swapped, resulting in some user interactions happening before the call to the `Scheduler` (and thus 
+  the `MessageEngine` and all `Node.onClock()`).
+  Everything is now properly synchronized.
+
+**Symbol modification in ClockManager**
+
+* `ClockManager.currentTime()` now returns an `int` instead of an `Integer`
+
+  This value could never be `null`. The return value being an object was a remnant of previous versions. 
+  
+[issue: #86]: https://github.com/jbotsim/JBotSim/issues/86
+
+### MessageEngine modifications
+
+[[issue 85]][issue: #85] [[issue 83]][issue: #83]
+ 
+Some changes have been applied in an effort to simplify, clarify and speed-up the *message engine* system.
+
+* `MessageEngine` is now an interface
+   * A `reset()` method has been added
+   * It does not handle delays anymore
+  
+
+* The former `MessageEngine` has been renamed to `DefaultMessageEngine`
+
+   `io.jbotsim.core.MessageEngine` -> `io.jbotsim.core.DefaultMessageEngine`
+   
+   * It does not handle delays (see `DelayMessageEngine`)
+   * It speeds-up former check on link existence
+   
+* A specific `DelayMessageEngine` has been re-created in `jbotsim-core`/`io.jbotsim.core`
+   
+   * It handles instantaneous delays better than the former `MessageEngine` used to
+   * It also handles general delays better than the former `MessageEngine` used to
+   * A new `DelayMessageEngine.disableLinksContinuityChecks()` method has been added
+    
+     This method prevents the system from checking the existence of the link each step while it is delayed. 
+     The check still remains at the end of the sending round and before the delivery round.
+     This speeds message processing up when you send a lot of delayed messages in a static environment.  
+   * `AsyncMessageEngine` and `RandomMessageEngine` implementations have been modified to benefit from the new
+   `DelayMessageEngine` capabilities
+   
+   * `RandomMessageEngine` has been renamed into `RandomDelayMessageEngine`
+     
+     `jbotsim-extras-common`/`io.jbotsim.contrib.messaging.RandomMessageEngine` -> `io.jbotsim.contrib.messaging.RandomDelayMessageEngine`
+   
+
+* Test classes and examples have been added to showcase all MessageEngines behaviors
+
+If you used to inherit from `MessageEngine`, you have several options:
+* inherit from `DefaultMessageEngine` (no delay feature)
+* inherit from `DelayMessageEngine` (has delay feature)
+* actually implement  the `MessageEngine` interface
+
+###  Topology class modifications
+
+**Bug fixes in Topology:**
+
+* `Topology.restart()` and `Topology.clearMessages()` now properly remove delayed messages [[issue 83]][issue: #83]
+ 
+  This is delegated to the new `MessageEngine.reset()` method. 
+
+[issue: #83]: https://github.com/jbotsim/JBotSim/issues/83
+
+###  Node class modifications
+
+**New symbols in Node:**
+  * `Node.hasNeighbor(Node)`, `Node.hasInNeighbor(Node)`, `Node.hasOutNeighbor(Node)` have been created [[issue 85]][issue: #85]
+  
+    These methods allow you to directly test the presence of the provided `Node` in the neighborhood of the object 
+    on which they are called. Please see documentation for details. 
+
+**Modifications in Node:**
+  * `Node.getOutNeighbors()` has been improved, avoiding unnecessary copies [[issue 85]][issue: #85]
+  
+###  Message class modifications
+
+**New symbol in Message:**
+
+  * `Message.isRetryModeEnabled()` accessor has been created [[issue 85]][issue: #85]
+  
+[issue: #85]: https://github.com/jbotsim/JBotSim/issues/85
+
+###  TikzTopologySerializer class modifications
+
+[[issue 80]][issue: #80]
+
+**Behavior modifications in TikzTopologySerializer:**
+
+* Directed links are now supported
+ 
+  Directed links are properly exported (using `"->"` option).
+  This supposes that `Topology.getOrientation()` returns `DIRECTED`. 
+* TikZ colors are now better supported
+* The previous *scale* parameter is now a proper scale factor
+
+  Its previous default value was `50`. It is now `1/50.`, resulting in the same default value.  
+
+**Symbol modifications in TikzTopologySerializer:**
+
+* The `TikzTopologySerializer.DEFAULT_EOL` constant has been added
+
+  This constant sets the value of the default End-Of-Line delimiter: `"\n"`.
+
+* The `TikzTopologySerializer.DEFAULT_SCALE_FACTOR` constant has been added
+
+  This constant sets the default scale factor that must be applied to the distance between nodes: `1/50`.
+
+* A new constructor `TikzTopologySerializer(String, double)` has been added
+
+  This constructor allows to specify custom values for both the *EOL* and the *scale factor*.
+
+* `exportTopology(Topology topology, double scaleFactor)` is now `protected`
+
+  It was previously `public`. You can achieve the same behavior by using the new constructor.
+   
+[issue: #80]: https://github.com/jbotsim/JBotSim/issues/80
+
+### New icon in the jbotsim-icons module
+
+`jbotsim-icons`/`io.jbotsim.ui.icons`
+
+* A fully transparent new icon has been added [[issue 84]][issue: #84] 
+  * `jbotsim-icons`/`io/jbotsim/ui/icons/transparent.png` 
+
+  As usual, it's path can be accessed using the corresponding constant `Icons.TRANSPARENT`.
+
+[issue: #84]: https://github.com/jbotsim/JBotSim/issues/84
+
+###  JNode class modifications
+
+[[issue 77]][issue: #77]
+
+**Bug fix in JNode:**
+
+* The wired `Link` created between two nodes using the Swing UI (start a right click on the first and drag to the second 
+before releasing the button) now takes `Topology.getOrientation()` into account instead of always creating undirected 
+links
+ 
+[issue: #77]: https://github.com/jbotsim/JBotSim/issues/77
 
 ##  [1.1.1] - 2019/09/26
 
@@ -807,7 +960,8 @@ have executed their onStart() method before that, you may simply call start()
 on your topology immediately followed by a call to pause().
 (Eventually we will provide an atomic call to this effect.)
 
-[Unreleased]: https://github.com/jbotsim/JBotSim/compare/v1.1.1...develop
+[Unreleased]: https://github.com/jbotsim/JBotSim/compare/v1.2.0...develop
+[1.2.0]: https://github.com/jbotsim/JBotSim/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/jbotsim/JBotSim/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/jbotsim/JBotSim/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/jbotsim/JBotSim/compare/v1.0.0-beta03...v1.0.0

README.md

@@ -1,6 +1,6 @@
 
 [![Build Status](https://travis-ci.org/jbotsim/JBotSim.svg?branch=master)][travis-jbotsim]
-[![Maven Central](https://img.shields.io/badge/maven%20central-1.1.1-informational.svg)][mavencentral-jbotsim-latest]
+[![Maven Central](https://img.shields.io/badge/maven%20central-1.2.0-informational.svg)][mavencentral-jbotsim-latest]
 [![License](https://img.shields.io/badge/license-LGPL%20≥%203.0-informational.svg)][lgpl3]
 
 
@@ -58,7 +58,7 @@ artifact will best suit your project's needs):
     * choose `From Maven ...`.
 
   * In the "Download Library from Maven Repository" popup:
-    * provide the following dependence `io.jbotsim:jbotsim-all:1.1.1`
+    * provide the following dependence `io.jbotsim:jbotsim-all:1.2.0`
     * make sure to tick `JavaDocs`
     * Hit `OK`.
   * Confirm that you want to add it to your (only) module.
@@ -98,7 +98,7 @@ examples.
 ## Current version
 
 
-The latest public version is [`1.1.1`][mavencentral-jbotsim-latest]. 
+The latest public version is [`1.2.0`][mavencentral-jbotsim-latest]. 
 Please see the [CHANGELOG.md](CHANGELOG.md) for previous versions modifications.
 
 
@@ -127,7 +127,7 @@ If your build system uses *Gradle*, you will want to add something like this to
 
 ```
 dependencies {
-    implementation "io.jbotsim:jbotsim-all:1.1.1"
+    implementation "io.jbotsim:jbotsim-all:1.2.0"
 }
 ```
 
@@ -140,15 +140,15 @@ If your build system uses *Maven*, you will want to add something like this to y
 <dependency>
   <groupId>io.jbotsim</groupId>
   <artifactId>jbotsim-all</artifactId>
-  <version>1.1.1</version>
+  <version>1.2.0</version>
 </dependency>
 ```
 
 ### Using IntelliJ IDEA
 
 If you use a _Java Project_ in _IntelliJ IDEA_, add the following dependency (as explained [here](#declaring-the-dependency)):
  ```
- io.jbotsim:jbotsim-all:1.1.1
+ io.jbotsim:jbotsim-all:1.2.0
  ```
 
 
@@ -178,7 +178,7 @@ The JBotSim project will gladly welcome help. If you consider contributing, plea
 
 ## License
 
-(C) Copyright 2008-2019, by [Arnaud Casteigts and the JBotSim contributors](CONTRIBUTORS.md). All rights reserved.
+(C) Copyright 2008-2020, by [Arnaud Casteigts and the JBotSim contributors](CONTRIBUTORS.md). All rights reserved.
 
 
 JBotSim is published under license [LGPL 3.0 or later][lgpl3]. 
@@ -206,7 +206,7 @@ gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys DFA48EDB1EDEBA6F
 
 [travis-jbotsim]: https://travis-ci.org/jbotsim/JBotSim
 [github-jbotsim]: https://github.com/jbotsim/JBotSim
-[mavencentral-jbotsim-latest]: https://search.maven.org/search?q=g:io.jbotsim%20AND%20v:1.1.1
+[mavencentral-jbotsim-latest]: https://search.maven.org/search?q=g:io.jbotsim%20AND%20v:1.2.0
 [mavencentral-jbotsim]: https://search.maven.org/search?q=g:io.jbotsim
 [github-jbotsim-issues]: https://github.com/jbotsim/JBotSim/issues
 [lgpl3]: http://www.gnu.org/licenses/lgpl-3.0.html

apps/examples/CreateUserProject.md

@@ -118,7 +118,7 @@ Any JBotSim classes, source code and documentation will automatically be downloa
     * choose `From Maven ...`.
 
   * In the "Download Library from Maven Repository" popup:
-    * provide the following dependency: `io.jbotsim:jbotsim-all:1.1.1`
+    * provide the following dependency: `io.jbotsim:jbotsim-all:1.2.0`
     * make sure to tick `JavaDocs`
     * Hit `OK`.
   * Confirm that you want to add it to your (only) module.
@@ -141,7 +141,7 @@ Simply add the following line to your `build.gradle`:
 
 ```
 dependencies {
-    implementation "io.jbotsim:jbotsim-all:1.1.1"
+    implementation "io.jbotsim:jbotsim-all:1.2.0"
 }
 ```
 
@@ -201,7 +201,7 @@ dependencies {
 
     ```
     dependencies {
-        compile files('mylibs/jbotsim-full-1.1.1.jar')
+        compile files('mylibs/jbotsim-full-1.2.0.jar')
     }
     ``` 
     

apps/examples/README.md

@@ -30,7 +30,7 @@ artifact suits your needs).
 So our `build.gradle` will simply declare the dependency as follows:
 ```
 dependencies {
-    implementation "io.jbotsim:jbotsim-ui-swing:1.1.1"
+    implementation "io.jbotsim:jbotsim-ui-swing:1.2.0"
 }
 ```
 Gradle and Maven will take care of retrieving any required dependencies.

apps/examples/src/main/java/examples/JBackgroundPainterHD.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
  *
  *
  * This file is part of JBotSim.

apps/examples/src/main/java/examples/JLinkPainterHD.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
  *
  *
  * This file is part of JBotSim.

apps/examples/src/main/java/examples/VideoHelper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
  *
  *
  * This file is part of JBotSim.

apps/examples/src/main/java/examples/basic/basic/BasicNode.java

@@ -1,3 +1,24 @@
+/*
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
 package examples.basic.basic;
 
 import io.jbotsim.core.Message;

apps/examples/src/main/java/examples/basic/broadcasting/BroadcastingNode.java

@@ -1,3 +1,24 @@
+/*
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
 package examples.basic.broadcasting;
 
 import io.jbotsim.core.Color;

apps/examples/src/main/java/examples/basic/broadcasting/Main.java

@@ -1,3 +1,24 @@
+/*
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
 package examples.basic.broadcasting;
 
 import io.jbotsim.core.Topology;