Did some clean up

[Mograsim.git] / era.mi / src / era / mi / logic / timeline / Timeline.java

diff --git a/era.mi/src/era/mi/logic/timeline/Timeline.java b/era.mi/src/era/mi/logic/timeline/Timeline.java
index 3e3b9f6..8107db9 100644 (file)
--- a/era.mi/src/era/mi/logic/timeline/Timeline.java
+++ b/era.mi/src/era/mi/logic/timeline/Timeline.java
@@ -7,6 +7,7 @@ import java.util.function.Consumer;
 
 /**
  * Orders Events by the time they are due to be executed. Can execute Events individually.
+ * 
  * @author Fabian Stemmler
  *
  */
@@ -14,21 +15,22 @@ public class Timeline
 {
        private PriorityQueue<InnerEvent> events;
        private long currentTime = 0;
-       
+
        private final List<Consumer<TimelineEvent>> eventAddedListener;
-       
+
        public Timeline(int initCapacity)
        {
-               events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) -> {
+               events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) ->
+               {
                        long difference = a.getTiming() - b.getTiming();
-                       if(difference == 0)
+                       if (difference == 0)
                                return 0;
                        return difference < 0 ? -1 : 1;
                });
-               
+
                eventAddedListener = new ArrayList<>();
        }
-       
+
        public boolean hasNext()
        {
                return !events.isEmpty();
@@ -40,21 +42,18 @@ public class Timeline
                currentTime = first.getTiming();
                first.run();
        }
-       
+
        public void executeAll()
        {
                while (hasNext())
                        executeNext();
        }
-       
+
        /**
-        * Executes all events up to a given simulation timestamp. The simulation
-        * process can be constrained by a real world timestamp.
+        * Executes all events up to a given simulation timestamp. The simulation process can be constrained by a real world timestamp.
         * 
-        * @param timestamp  the simulation timestamp up to which the events will be
-        *                   processed
-        * @param stopMillis the System.currentTimeMillis() when simulation definitely
-        *                   needs to stop.
+        * @param timestamp  the simulation timestamp up to which the events will be processed
+        * @param stopMillis the System.currentTimeMillis() when simulation definitely needs to stop.
         * @return if it was possible to fulfil the goal in the given real world time.
         * @author Christian Femers
         */
@@ -89,12 +88,11 @@ public class Timeline
 
        public long nextEventTime()
        {
-               if(!hasNext())
+               if (!hasNext())
                        return -1;
-               else
-                       return events.peek().timing;
+               return events.peek().timing;
        }
-       
+
        public void reset()
        {
                events.clear();
@@ -105,14 +103,16 @@ public class Timeline
        {
                eventAddedListener.add(listener);
        }
+
        public void removeEventAddedListener(Consumer<TimelineEvent> listener)
        {
                eventAddedListener.remove(listener);
        }
-       
+
        /**
         * Adds an Event to the {@link Timeline}
-        * @param function The {@link TimelineEventHandler} that will be executed, when the {@link InnerEvent} occurs on the timeline.
+        * 
+        * @param function       The {@link TimelineEventHandler} that will be executed, when the {@link InnerEvent} occurs on the timeline.
         * @param relativeTiming The amount of MI ticks in which the {@link InnerEvent} is called, starting from the current time.
         */
        public void addEvent(TimelineEventHandler function, int relativeTiming)
@@ -122,18 +122,19 @@ public class Timeline
                events.add(new InnerEvent(function, event, timing));
                eventAddedListener.forEach(l -> l.accept(event));
        }
-       
+
        private class InnerEvent
        {
 
-               private final long timing;
+               final long timing;
                private final TimelineEventHandler function;
                private final TimelineEvent event;
-               
+
                /**
                 * Creates an {@link InnerEvent}
+                * 
                 * @param function {@link TimelineEventHandler} to be executed when the {@link InnerEvent} occurs
-                * @param timing Point in the MI simulation {@link Timeline}, at which the {@link InnerEvent} is executed;
+                * @param timing   Point in the MI simulation {@link Timeline}, at which the {@link InnerEvent} is executed;
                 */
                InnerEvent(TimelineEventHandler function, TimelineEvent event, long timing)
                {
@@ -146,32 +147,32 @@ public class Timeline
                {
                        return timing;
                }
-               
+
                public void run()
                {
                        function.handle(event);
                }
-               
+
                @Override
                public String toString()
                {
                        return event.toString();
                }
        }
-       
+
        @Override
        public String toString()
        {
                return "simulation time: " + currentTime + ", " + events.toString();
        }
-       
+
        public static long toNanoseconds(long ticks)
        {
-               return ticks; //TODO: Alter this when it has been determined how ticks should relate to real time.
+               return ticks; // TODO: Alter this when it has been determined how ticks should relate to real time.
        }
-       
+
        public enum ExecutionResult
        {
-               NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME 
+               NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME
        }
 }
\ No newline at end of file