Correct Yerushalmi spellings in Daf.java

KosherJava · web-flow · commit fc95e3a6984e · 2023-05-29T00:00:13.000-04:00
- Closes #208 (Thanks @elazarrosenthal) - Fixes spelling of the Yerushalmi name. This meant creating a number of new methods and deprecating the misspelled ones for removal in 3.0.0. - Minor JavaDoc tweaks
diff --git a/src/main/java/com/kosherjava/zmanim/hebrewcalendar/Daf.java b/src/main/java/com/kosherjava/zmanim/hebrewcalendar/Daf.java
@@ -1,6 +1,6 @@
 /*
  * Zmanim Java API
- * Copyright (C) 2011 - 2020 Eliyahu Hershfeld
+ * Copyright (C) 2011 - 2023 Eliyahu Hershfeld
  *
  * This library 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 2.1 of the License, or (at your option)
@@ -17,9 +17,9 @@
 package com.kosherjava.zmanim.hebrewcalendar;
 
 /**
- * An Object representing a Daf in the Daf Yomi cycle.
+ * An Object representing a <em>daf</em> (page) in the <a href="https://en.wikipedia.org/wiki/Daf_Yomi">Daf Yomi</a> cycle.
  * 
- * @author &copy; Eliyahu Hershfeld 2011 - 2020
+ * @author &copy; Eliyahu Hershfeld 2011 - 2023
  */
 public class Daf {
 	/**
@@ -63,7 +63,7 @@ public class Daf {
 			"\u05E0\u05D3\u05D4" };
 	
 	/**
-	 * See {@link #getYerushlmiMasechtaTransliterated()}.
+	 * See {@link #getYerushalmiMasechtaTransliterated()}.
 	 */
 	private static String[] masechtosYerushalmiTransliterated = { "Berachos", "Pe'ah", "Demai", "Kilayim", "Shevi'is",
 			"Terumos", "Ma'asros", "Ma'aser Sheni", "Chalah", "Orlah", "Bikurim", "Shabbos", "Eruvin", "Pesachim",
@@ -74,8 +74,8 @@ public class Daf {
 	/**
 	 * See {@link #getYerushalmiMasechta()}.
 	 */
-	private static final String[] masechtosYerushlmi = { "\u05d1\u05e8\u05db\u05d5\u05ea","\u05e4\u05d9\u05d0\u05d4",
-			"\u05d3\u05de\u05d0\u05d9","\u05db\u05dc\u05d0\u05d9\u05d9\u05dd","\u05e9\u05d1\u05d9\u05e2\u05d9\u05ea",
+	private static final String[] masechtosYerushalmi = { "\u05d1\u05e8\u05db\u05d5\u05ea","\u05e4\u05d9\u05d0\u05d4",
+			"\u05d3\u05de\u05d0\u05d9","\u05db\u05dc\u05d0\u05d9\u05dd","\u05e9\u05d1\u05d9\u05e2\u05d9\u05ea",
 			"\u05ea\u05e8\u05d5\u05de\u05d5\u05ea","\u05de\u05e2\u05e9\u05e8\u05d5\u05ea","\u05de\u05e2\u05e9\u05e8 \u05e9\u05e0\u05d9",
 			"\u05d7\u05dc\u05d4","\u05e2\u05d5\u05e8\u05dc\u05d4","\u05d1\u05d9\u05db\u05d5\u05e8\u05d9\u05dd",
 			"\u05e9\u05d1\u05ea","\u05e2\u05d9\u05e8\u05d5\u05d1\u05d9\u05df","\u05e4\u05e1\u05d7\u05d9\u05dd",
@@ -90,87 +90,87 @@ public class Daf {
 			"\u05d0\u05d9\u05df \u05d3\u05e3 \u05d4\u05d9\u05d5\u05dd" };
 
 	/**
-	 * Gets the masechta number of the currently set Daf. The sequence is: Berachos, Shabbos, Eruvin, Pesachim,
-	 * Shekalim, Yoma, Sukkah, Beitzah, Rosh Hashana, Taanis, Megillah, Moed Katan, Chagigah, Yevamos, Kesubos, Nedarim,
-	 * Nazir, Sotah, Gitin, Kiddushin, Bava Kamma, Bava Metzia, Bava Basra, Sanhedrin, Makkos, Shevuos, Avodah Zarah,
-	 * Horiyos, Zevachim, Menachos, Chullin, Bechoros, Arachin, Temurah, Kerisos, Meilah, Kinnim, Tamid, Midos and
+	 * Gets the <em>masechta</em> number of the currently set <em>Daf</em>. The sequence is: Berachos, Shabbos, Eruvin,
+	 * Pesachim, Shekalim, Yoma, Sukkah, Beitzah, Rosh Hashana, Taanis, Megillah, Moed Katan, Chagigah, Yevamos, Kesubos,
+	 * Nedarim, Nazir, Sotah, Gitin, Kiddushin, Bava Kamma, Bava Metzia, Bava Basra, Sanhedrin, Makkos, Shevuos, Avodah
+	 * Zarah, Horiyos, Zevachim, Menachos, Chullin, Bechoros, Arachin, Temurah, Kerisos, Meilah, Kinnim, Tamid, Midos and
 	 * Niddah.
-	 * @return the masechtaNumber
+	 * @return the masechtaNumber.
 	 * @see #setMasechtaNumber(int)
 	 */
 	public int getMasechtaNumber() {
 		return masechtaNumber;
 	}
 
 	/**
-	 * Set the masechta number in the order of the Daf Yomi. The sequence is: Berachos, Shabbos, Eruvin, Pesachim,
+	 * Set the <em>masechta</em> number in the order of the Daf Yomi. The sequence is: Berachos, Shabbos, Eruvin, Pesachim,
 	 * Shekalim, Yoma, Sukkah, Beitzah, Rosh Hashana, Taanis, Megillah, Moed Katan, Chagigah, Yevamos, Kesubos, Nedarim,
 	 * Nazir, Sotah, Gitin, Kiddushin, Bava Kamma, Bava Metzia, Bava Basra, Sanhedrin, Makkos, Shevuos, Avodah Zarah,
 	 * Horiyos, Zevachim, Menachos, Chullin, Bechoros, Arachin, Temurah, Kerisos, Meilah, Kinnim, Tamid, Midos and
 	 * Niddah.
 	 * 
 	 * @param masechtaNumber
-	 *            the masechtaNumber in the order of the Daf Yomi to set
+	 *            the <em>masechta</em> number in the order of the Daf Yomi to set.
 	 */
 	public void setMasechtaNumber(int masechtaNumber) {
 		this.masechtaNumber = masechtaNumber;
 	}
 
 	/**
-	 * Constructor that creates a Daf setting the {@link #setMasechtaNumber(int) masechta Number} and
-	 * {@link #setDaf(int) daf Number}
+	 * Constructor that creates a Daf setting the {@link #setMasechtaNumber(int) <em>masechta</em> number} and
+	 * {@link #setDaf(int) <em>daf</em> number}.
 	 * 
-	 * @param masechtaNumber the masechtaNumber in the order of the Daf Yomi to set
-	 * @param daf the daf (page) number to set
+	 * @param masechtaNumber the <em>masechta</em> number in the order of the Daf Yomi to set as the current <em>masechta</em>.
+	 * @param daf the <em>daf</em> (page) number to set.
 	 */
 	public Daf(int masechtaNumber, int daf) {
 		this.masechtaNumber = masechtaNumber;
 		this.daf = daf;
 	}
 
 	/**
-	 * Returns the daf (page number) of the Daf Yomi
-	 * @return the daf (page number) of the Daf Yomi
+	 * Returns the <em>daf</em> (page) number of the Daf Yomi.
+	 * @return the <em>daf</em> (page) number of the Daf Yomi.
 	 */
 	public int getDaf() {
 		return daf;
 	}
 
 	/**
-	 * Sets the daf (page number) of the Daf Yomi
-	 * @param daf the daf (page) number
+	 * Sets the <em>daf</em> (page) number of the Daf Yomi.
+	 * @param daf the <em>daf</em> (page) number.
 	 */
 	public void setDaf(int daf) {
 		this.daf = daf;
 	}
 
 	/**
-	 * Returns the transliterated name of the masechta (tractate) of the Daf Yomi. The list of mashechtos is: Berachos,
-	 * Shabbos, Eruvin, Pesachim, Shekalim, Yoma, Sukkah, Beitzah, Rosh Hashana, Taanis, Megillah, Moed Katan, Chagigah,
-	 * Yevamos, Kesubos, Nedarim, Nazir, Sotah, Gitin, Kiddushin, Bava Kamma, Bava Metzia, Bava Basra, Sanhedrin,
+	 * Returns the transliterated name of the <em>masechta</em> (tractate) of the Daf Yomi. The list of <em>mashechtos</em>
+	 * is: Berachos, Shabbos, Eruvin, Pesachim, Shekalim, Yoma, Sukkah, Beitzah, Rosh Hashana, Taanis, Megillah, Moed Katan,
+	 * Chagigah, Yevamos, Kesubos, Nedarim, Nazir, Sotah, Gitin, Kiddushin, Bava Kamma, Bava Metzia, Bava Basra, Sanhedrin,
 	 * Makkos, Shevuos, Avodah Zarah, Horiyos, Zevachim, Menachos, Chullin, Bechoros, Arachin, Temurah, Kerisos, Meilah,
 	 * Kinnim, Tamid, Midos and Niddah.
 	 * 
-	 * @return the transliterated name of the masechta (tractate) of the Daf Yomi such as Berachos.
+	 * @return the transliterated name of the <em>masechta</em> (tractate) of the Daf Yomi such as Berachos.
 	 * @see #setMasechtaTransliterated(String[])
 	 */
 	public String getMasechtaTransliterated() {
 		return masechtosBavliTransliterated[masechtaNumber];
 	}
 	
 	/**
-	 * Setter method to allow overriding of the default list of masechtos transliterated into into Latin chars. The default
-	 * uses Ashkenazi American English transliteration.
+	 * Setter method to allow overriding of the default list of <em>masechtos</em> transliterated into into Latin chars.
+	 * The default values use Ashkenazi American English transliteration.
 	 * 
-	 * @param masechtosBavliTransliterated the list of transliterated Bavli masechtos to set.
+	 * @param masechtosBavliTransliterated the list of transliterated Bavli <em>masechtos</em> to set.
 	 * @see #getMasechtaTransliterated()
 	 */
 	public void setMasechtaTransliterated(String[] masechtosBavliTransliterated) {
 		Daf.masechtosBavliTransliterated = masechtosBavliTransliterated;
 	}
 
 	/**
-	 * Returns the masechta (tractate) of the Daf Yomi in Hebrew. The list is in the following format<br>
+	 * Returns the <em>masechta</em> (tractate) of the Daf Yomi in Hebrew. The list is in the following format<br>
 	 * <code>["&#x05D1;&#x05E8;&#x05DB;&#x05D5;&#x05EA;",
 	 * "&#x05E9;&#x05D1;&#x05EA;", "&#x05E2;&#x05D9;&#x05E8;&#x05D5;&#x05D1;&#x05D9;&#x05DF;",
 	 * "&#x05E4;&#x05E1;&#x05D7;&#x05D9;&#x05DD;", "&#x05E9;&#x05E7;&#x05DC;&#x05D9;&#x05DD;", "&#x05D9;&#x05D5;&#x05DE;&#x05D0;",
@@ -188,64 +188,104 @@ public void setMasechtaTransliterated(String[] masechtosBavliTransliterated) {
 	 * "&#x05DE;&#x05E2;&#x05D9;&#x05DC;&#x05D4;", "&#x05E7;&#x05D9;&#x05E0;&#x05D9;&#x05DD;", "&#x05EA;&#x05DE;&#x05D9;&#x05D3;",
 	 * "&#x05DE;&#x05D9;&#x05D3;&#x05D5;&#x05EA;", "&#x05E0;&#x05D3;&#x05D4;"]</code>.
 	 * 
-	 * @return the masechta (tractate) of the Daf Yomi in Hebrew, It will return
+	 * @return the <em>masechta</em> (tractate) of the Daf Yomi in Hebrew. As an example, it will return
 	 *         &#x05D1;&#x05E8;&#x05DB;&#x05D5;&#x05EA; for Berachos.
 	 */
 	public String getMasechta() {
 		return masechtosBavli[masechtaNumber];
 	}
 
 	/**
-	 * Returns the transliterated name of the masechta (tractate) of the Daf Yomi in Yerushalmi. The list of mashechtos is: 
+	 * Returns the transliterated name of the <em>masechta</em> (tractate) of the Daf Yomi in Yerushalmi. The list of
+	 * <em>mashechtos</em> is:
 	 * Berachos, Pe'ah, Demai, Kilayim, Shevi'is, Terumos, Ma'asros, Ma'aser Sheni, Chalah, Orlah, Bikurim, 
 	 * Shabbos, Eruvin, Pesachim, Beitzah, Rosh Hashanah, Yoma, Sukah, Ta'anis, Shekalim, Megilah, Chagigah, 
 	 * Moed Katan, Yevamos, Kesuvos, Sotah, Nedarim, Nazir, Gitin, Kidushin, Bava Kama, Bava Metzia,
 	 * Bava Basra, Shevuos, Makos, Sanhedrin, Avodah Zarah, Horayos, Nidah and No Daf Today.
 	 * 
-	 * @return the transliterated name of the masechta (tractate) of the Daf Yomi such as Berachos.
+	 * @return the transliterated name of the <em>masechta</em> (tractate) of the Daf Yomi such as Berachos.
 	 */
-	public String getYerushlmiMasechtaTransliterated() {
+	public String getYerushalmiMasechtaTransliterated() {
 		return masechtosYerushalmiTransliterated[masechtaNumber];
 	}
 	
 	/**
-	 * Setter method to allow overriding of the default list of Yerushalmi masechtos transliterated into into Latin chars.
+	 * @see #getYerushalmiMasechtaTransliterated()
+	 * @deprecated misspelled method name to be removed in 3.0.0.
+	 * @return the transliterated name of the <em>masechta</em> (tractate) of the Daf Yomi such as Berachos.
+	 */
+	@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
+	public String getYerushlmiMasechtaTransliterated() {
+		return getYerushalmiMasechtaTransliterated();
+	}
+	
+	/**
+	 * Setter method to allow overriding of the default list of Yerushalmi <em>masechtos</em> transliterated into into Latin chars.
 	 * The default uses Ashkenazi American English transliteration.
 	 * 
-	 * @param masechtosYerushalmiTransliterated the list of transliterated Yerushalmi masechtos to set.
+	 * @param masechtosYerushalmiTransliterated the list of transliterated Yerushalmi <em>masechtos</em> to set.
 	 */
-	public void setYerushlmiMasechtaTransliterated(String[] masechtosYerushalmiTransliterated) {
+	public void setYerushalmiMasechtaTransliterated(String[] masechtosYerushalmiTransliterated) {
 		Daf.masechtosYerushalmiTransliterated = masechtosYerushalmiTransliterated;
 	}
 	
 	/**
-	 * Getter method to allow retrieving the list of Yerushalmi masechtos transliterated into into Latin chars.
+	 * @see #setYerushalmiMasechtaTransliterated(String[])
+	 * @deprecated misspelled method name to be removed in 3.0.0.
+	 * @param masechtosYerushalmiTransliterated the list of transliterated Yerushalmi <em>masechtos</em> to set.
+	 */
+	@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
+	public void setYerushlmiMasechtaTransliterated(String[] masechtosYerushalmiTransliterated) {
+		setYerushalmiMasechtaTransliterated(masechtosYerushalmiTransliterated);
+	}
+	
+	/**
+	 * Getter method to allow retrieving the list of Yerushalmi <em>masechtos</em> transliterated into into Latin chars.
 	 * The default uses Ashkenazi American English transliteration.
 	 * 
-	 * @return the array of transliterated masechta (tractate) names of the Daf Yomi Yerushalmi.
+	 * @return the array of transliterated <em>masechta</em> (tractate) names of the Daf Yomi Yerushalmi.
 	 */
-	public static String[] getYerushlmiMasechtosTransliterated() {
+	public static String[] getYerushalmiMasechtosTransliterated() {
 		return masechtosYerushalmiTransliterated;
 	}
 	
 	/**
-	 * Getter method to allow retrieving the list of Yerushalmi masechtos.
+	 * @see #getYerushalmiMasechtosTransliterated()
+	 * @deprecated misspelled method name to be removed in 3.0.0.
+	 * @return the array of transliterated <em>masechta</em> (tractate) names of the Daf Yomi Yerushalmi.
+	 */
+	@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
+	public static String[] getYerushlmiMasechtosTransliterated() {
+		return getYerushalmiMasechtosTransliterated();
+	}
+	
+	/**
+	 * Getter method to allow retrieving the list of Yerushalmi <em>masechtos</em>.
 	 * 
-	 * @return the array of Hebrew masechta (tractate) names of the Daf Yomi Yerushalmi.
+	 * @return the array of Hebrew <em>masechta</em> (tractate) names of the Daf Yomi Yerushalmi.
+	 */
+	public static String[] getYerushalmiMasechtos() {
+		return masechtosYerushalmi;
+	}
+	
+	/**
+	 * @see #getYerushalmiMasechtos()
+	 * @deprecated misspelled method name to be removed in 3.0.0.
+	 * @return the array of Hebrew <em>masechta</em> (tractate) names of the Daf Yomi Yerushalmi.
 	 */
+	@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
 	public static String[] getYerushlmiMasechtos() {
-		return masechtosYerushlmi;
+		return getYerushalmiMasechtos();
 	}
 
 	/**
-	 * Returns the Yerushlmi masechta (tractate) of the Daf Yomi in Hebrew, It will return
+	 * Returns the Yerushalmi <em>masechta</em> (tractate) of the Daf Yomi in Hebrew. As an example, it will return
 	 * &#x05D1;&#x05E8;&#x05DB;&#x05D5;&#x05EA; for Berachos.
 	 * 
-	 * @return the Yerushalmi masechta (tractate) of the Daf Yomi in Hebrew, It will return
+	 * @return the Yerushalmi <em>masechta</em> (tractate) of the Daf Yomi in Hebrew. As an example, it will return
 	 *         &#x05D1;&#x05E8;&#x05DB;&#x05D5;&#x05EA; for Berachos.
 	 */
 	public String getYerushalmiMasechta() {
-		return masechtosYerushlmi[masechtaNumber];
+		return masechtosYerushalmi[masechtaNumber];
 	}
-
 }
