Start using java.time classes

Breaking changes

Author: KosherJava

src/main/java/com/kosherjava/zmanim/util/Zman.java

@@ -15,9 +15,9 @@
  */
 package com.kosherjava.zmanim.util;
 
-import java.text.SimpleDateFormat;
+import java.time.Instant;
+import java.time.format.DateTimeFormatter;
 import java.util.Comparator;
-import java.util.Date;
 
 /**
  * A wrapper class for astronomical times / <em>zmanim</em> that is mostly intended to allow sorting collections of astronomical times.
@@ -36,7 +36,7 @@
  * TimeZone timeZone = TimeZone.getTimeZone(&quot;America/New_York&quot;);
  * GeoLocation location = new GeoLocation(locationName, latitude, longitude, elevation, timeZone);
  * ComprehensiveZmanimCalendar czc = new ComprehensiveZmanimCalendar(location);
-  * Zman sunset = new Zman(czc.getSunset(), "Sunset");
+ * Zman sunset = new Zman(czc.getSunset(), "Sunset");
  * Zman shaah16 = new Zman(czc.getShaahZmanis16Point1Degrees(), "Shaah zmanis 16.1");
  * Zman sunrise = new Zman(czc.getSunrise(), "Sunrise");
  * Zman shaah = new Zman(czc.getShaahZmanisGra(), "Shaah zmanis GRA");
@@ -67,9 +67,9 @@ public class Zman {
 	private String label;
 
 	/**
-	 * The {@link Date} of the <em>zman</em>
+	 * The {@link Instant} of the <em>zman</em>
 	 */
-	private Date zman;
+	private Instant zman;
 
 	/**
 	 * The duration if the <em>zman</em> is  a {@link com.kosherjava.zmanim.AstronomicalCalendar#getTemporalHour() temporal hour} (or the various
@@ -87,27 +87,27 @@ public class Zman {
 	 * The location information of the <em>zman</em>.
 	 */
 	private GeoLocation geoLocation;
-
+	
 	/**
-	 * The constructor setting a {@link Date} based <em>zman</em> and a label. In most cases you will likely want to call
-	 * {@link #Zman(Date, GeoLocation, String)} that also sets the location.
-	 * @param date the Date of the <em>zman</em>.
-	 * @param label the label of the  <em>zman</em> such as "<em>Sof Zman Krias Shema GRA</em>".
-	 * @see #Zman(Date, GeoLocation, String)
+	 * The constructor setting a {@link Instant} based <em>zman</em> and a label. In most cases you will likely want to call
+	 * {@link #Zman(Instant, GeoLocation, String)} that also sets the location.
+	 * @param instant the <code>Instant</code> of the <em>zman</em>.
+	 * @param label the label of the <em>zman</em> such as "<em>Sof Zman Krias Shema GRA</em>".
+	 * @see #Zman(Instant, GeoLocation, String)
 	 */
-	public Zman(Date date, String label) {
-		this(date, null, label);
+	public Zman(Instant instant, String label) {
+		this(instant, null, label);
 	}
 
 	/**
-	 * The constructor setting a {@link Date} based <em>zman</em> and a label. In most cases you will likely want to call
-	 * {@link #Zman(Date, GeoLocation, String)} that also sets the geo location.
-	 * @param date the Date of the <em>zman</em>.
+	 * The constructor setting a {@link Instant} based <em>zman</em> and a label. In most cases you will likely want to call
+	 * {@link #Zman(Instant, GeoLocation, String)} that also sets the geo location.
+	 * @param instant the <code>Instant</code> of the <em>zman</em>.
 	 * @param geoLocation the {@link GeoLocation} of the <em>zman</em>.
 	 * @param label the label of the  <em>zman</em> such as "<em>Sof Zman Krias Shema GRA</em>".
 	 */
-	public Zman(Date date, GeoLocation geoLocation, String label) {
-		this.zman = date;
+	public Zman(Instant instant, GeoLocation geoLocation, String label) {
+		this.zman = instant;
 		this.geoLocation = geoLocation;
 		this.label = label;
 	}
@@ -119,29 +119,29 @@ public Zman(Date date, GeoLocation geoLocation, String label) {
 	 * {@link com.kosherjava.zmanim.ComprehensiveZmanimCalendar#getShaahZmanis16Point1Degrees() <em>shaah Zmanis 16.1&deg;</em>}) and label.
 	 * @param duration a duration based <em>zman</em> such as ({@link com.kosherjava.zmanim.AstronomicalCalendar#getTemporalHour()}
 	 * @param label the label of the  <em>zman</em> such as "<em>Shaah Zmanis GRA</em>".
-	 * @see #Zman(Date, String)
+	 * @see #Zman(Instant, String)
 	 */
 	public Zman(long duration, String label) {
 		this.label = label;
 		this.duration = duration;
 	}
 
 	/**
-	 * Returns the {@code Date} based <em>zman</em>.
-	 * @return the <em>zman</em>.
-	 * @see #setZman(Date)
+	 * Returns the {@code Instant} based <em>zman</em>.
+	 * @return the <code>Instant</code> of the <em>zman</em>.
+	 * @see #setZman(Instant)
 	 */
-	public Date getZman() {
+	public Instant getZman() {
 		return this.zman;
 	}
 
 	/**
-	 * Sets a {@code Date} based <em>zman</em>.
-	 * @param date a {@code Date} based <em>zman</em>
+	 * Sets a {@code Instant} based <em>zman</em>.
+	 * @param instant an {@code Instant} based <em>zman</em>
 	 * @see #getZman()
 	 */
-	public void setZman(Date date) {
-		this.zman = date;
+	public void setZman(Instant instant) {
+		this.zman = instant;
 	}
 
 	/**
@@ -229,8 +229,8 @@ public void setDescription(String description) {
 	 */
 	public static final Comparator<Zman> DATE_ORDER = new Comparator<Zman>() {
 		public int compare(Zman zman1, Zman zman2) {
-			long firstTime = (zman1 == null || zman1.getZman() == null) ? Long.MAX_VALUE : zman1.getZman().getTime();
-			long secondTime = (zman2 == null || zman2.getZman() == null) ? Long.MAX_VALUE : zman2.getZman().getTime();
+			long firstTime = (zman1 == null || zman1.getZman() == null) ? Long.MAX_VALUE : zman1.getZman().toEpochMilli();
+			long secondTime = (zman2 == null || zman2.getZman() == null) ? Long.MAX_VALUE : zman2.getZman().toEpochMilli();
 			return Long.valueOf(firstTime).compareTo(Long.valueOf(secondTime));
 		}
 	};
@@ -288,7 +288,7 @@ public int compare(Zman zman1, Zman zman2) {
 	 * @return The XML formatted <code>String</code>.
 	 */
 	public String toXML() {
-		SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS");
+		DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSS");
 		StringBuilder sb = new StringBuilder();
 		sb.append("<Zman>\n");
 		sb.append("\t<Label>").append(getLabel()).append("</Label>\n");