Merge pull request #13 from DavidTheExplorer/1.7.0

v1.7.0 - Immutability change, Better thread name.

Author: DavidTheExplorer

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>dte</groupId>
 	<artifactId>tzevaadomapi</artifactId>
-	<version>1.6.0</version>
+	<version>1.7.0</version>
 
 	<build>
 		<plugins>

src/main/java/dte/tzevaadomapi/alertsource/AlertSource.java

@@ -5,7 +5,7 @@
 import dte.tzevaadomapi.alert.Alert;
 
 /**
- * Responsible of providing information about Tzeva Adoms in Israel. The info comes in form of {@link Alert} objects.
+ * Provides information about Tzeva Adoms in Israel, in form of {@link Alert} objects.
  */
 public interface AlertSource
 {

src/main/java/dte/tzevaadomapi/alertsource/OnlineAlertSource.java

@@ -9,9 +9,9 @@
 import java.net.URLConnection;
 
 /**
- * Represents a source that requires internet connection in order to access. 
+ * Represents a source that requires internet connection in order to access.
  * <p>
- * This class holds the essential connection details(the url, a possible proxy, etc) and provides convenient connection methods.
+ * This class takes care of the essential connection details(the url, a possible proxy) and provides convenient connection methods.
  */
 public abstract class OnlineAlertSource implements AlertSource
 {

src/main/java/dte/tzevaadomapi/alertsource/PHOAlertSource.java

@@ -20,7 +20,7 @@
 import dte.tzevaadomapi.utils.UncheckedExceptions.CheckedFunction;
 
 /**
- * Requests Alerts from the the website of Pikud Ha Oref.
+ * Requests Alerts from Pikud Ha'Oref.
  */
 public class PHOAlertSource extends OnlineAlertSource
 {

src/main/java/dte/tzevaadomapi/notifier/TzevaAdomHistory.java

@@ -15,22 +15,12 @@ public class TzevaAdomHistory implements Iterable<Alert>
 {
 	private final Deque<Alert> history = new LinkedList<>();
 
-	/**
-	 * Records a new alert.
-	 * 
-	 * @param alert The alert.
-	 */
-	public void update(Alert alert) 
-	{
-		this.history.add(alert);
-	}
-	
 	/**
 	 * Records a collection of alerts.
 	 * 
 	 * @param alerts The alerts.
 	 */
-	public void update(Collection<Alert> alerts)
+	void update(Collection<Alert> alerts)
 	{
 		this.history.addAll(alerts);
 	}

src/main/java/dte/tzevaadomapi/notifier/TzevaAdomNotifier.java

@@ -5,6 +5,8 @@
 import java.util.HashSet;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
 
@@ -24,7 +26,7 @@ public class TzevaAdomNotifier
 	private final Consumer<Exception> requestFailureHandler;
 	private final Set<TzevaAdomListener> listeners = new HashSet<>();
 	private final TzevaAdomHistory history = new TzevaAdomHistory();
-	private Alert mostRecentAlert; //only used in listen(), holding it here solves the effectively final problem
+	private Alert mostRecentAlert; //only used in listenAsync(), holding it here solves the effectively final problem
 
 	private TzevaAdomNotifier(AlertSource alertSource, Duration requestDelay, Consumer<Exception> requestFailureHandler) 
 	{
@@ -49,7 +51,7 @@ public CompletableFuture<Void> listenAsync()
 
 			while(true)	
 			{
-				Deque<Alert> newAlerts = request(() -> this.alertSource.getSince(this.mostRecentAlert));
+				Deque<Alert> newAlerts = requestFromSource(() -> this.alertSource.getSince(this.mostRecentAlert));
 
 				//if there are no new alerts - it's not Tzeva Adom
 				if(newAlerts.isEmpty()) 
@@ -62,7 +64,7 @@ public CompletableFuture<Void> listenAsync()
 				//notify Tzeva Adom
 				newAlerts.forEach(this::notifyListeners);
 			}
-		});
+		}, Executors.newSingleThreadExecutor(runnable -> new Thread(runnable, "Tzeva-Adom-Notifier")));
 	}
 
 	/**
@@ -76,7 +78,7 @@ public void addListener(TzevaAdomListener listener)
 	}
 
 	/**
-	 * Returns the Tzeva Adom history since {@link #listen()} was called for this notifier.
+	 * Returns the captured history since {@link #listenAsync()} was called.
 	 * 
 	 * @return The tzeva adom history.
 	 */
@@ -92,27 +94,27 @@ private Alert requestMostRecentAlert()
 		//wait until Hamas decides to launch rockets
 		do 
 		{
-			alert = request(this.alertSource::getMostRecentAlert);
+			alert = requestFromSource(this.alertSource::getMostRecentAlert);
 		}
 		while(alert == AlertSource.NO_RESULT);
 
 		return alert;
 	}
 
-	private <R> R request(CheckedSupplier<R> resultFactory)
+	private <T> T requestFromSource(CheckedSupplier<T> resultFactory)
 	{
 		while(true)
 		{
 			try 
 			{
-				//sleep a reasonable amount of time
+				//sleep the defined delay
 				TimeUnit.MILLISECONDS.sleep(this.requestDelay.toMillis());
 
 				return resultFactory.get();
 			}
 			catch(Exception exception) 
 			{
-				//pass the exception to the handler
+				//handle the exception and request again
 				this.requestFailureHandler.accept(exception);
 			}
 		}