From 543869769d420e4dcbf0f2ba84cd8ce245318169 Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Tue, 27 Sep 2022 19:09:35 -0400
Subject: A few updates

---
 src/main/java/tlIItools/LevelRange.java | 44 +++++++++++++++++++++++++++++----
 1 file changed, 39 insertions(+), 5 deletions(-)

(limited to 'src/main/java/tlIItools/LevelRange.java')

diff --git a/src/main/java/tlIItools/LevelRange.java b/src/main/java/tlIItools/LevelRange.java
index b0d620bf..0cc803dd 100644
--- a/src/main/java/tlIItools/LevelRange.java
+++ b/src/main/java/tlIItools/LevelRange.java
@@ -2,6 +2,12 @@ package tlIItools;
 
 import java.util.*;
 
+/**
+ * Represents a range of levels.
+ * 
+ * @author bjcul
+ *
+ */
 public class LevelRange implements Comparable<LevelRange> {
 	/*
 	 * if (minLevel <= 1 && maxLevel == 999) {
@@ -19,14 +25,29 @@ public class LevelRange implements Comparable<LevelRange> {
 	 * sb.append(minLevel);
 	 * } */
 
+	/**
+	 * The maximum level for this range.
+	 */
 	public int minLevel;
+	/**
+	 * The minimum level for this range.
+	 */
 	public int maxLevel;
 
+	/**
+	 * Create a new blank level range
+	 */
 	public LevelRange() {
 		minLevel = 1;
 		maxLevel = 999;
 	}
 
+	/**
+	 * Create a new set level range.
+	 * 
+	 * @param minLevel The minimum level
+	 * @param maxLevel The maximum level
+	 */
 	public LevelRange(int minLevel, int maxLevel) {
 		this.minLevel = minLevel;
 		this.maxLevel = maxLevel;
@@ -37,14 +58,29 @@ public class LevelRange implements Comparable<LevelRange> {
 		maxLevel = Math.min(999, maxLevel);
 	}
 
+	/**
+	 * Check if this level range is 'unrestricted'
+	 * 
+	 * @return Whether the level range is unrestricted
+	 */
 	public boolean isUnrestricted() {
 		return minLevel <= 1 && maxLevel >= 999;
 	}
 
+	/**
+	 * Check if this range has no lower bound
+	 * 
+	 * @return Whether the range has no lower bound
+	 */
 	public boolean noLowerBound() {
 		return minLevel <= 1;
 	}
 
+	/**
+	 * Check if this range has no upper bound
+	 * 
+	 * @return Whether the range has no upper bound
+	 */
 	public boolean noUpperBound() {
 		return maxLevel >= 999;
 	}
@@ -118,18 +154,16 @@ public class LevelRange implements Comparable<LevelRange> {
 		if (noLowerBound()) {
 		        if (other.noLowerBound()) {
 		            return maxLevel - other.maxLevel;
-		        } else {
-		            return -1;
 		        }
+				return -1;
 		} else if (noUpperBound()) {
 			if (other.noUpperBound()) {
 				return minLevel - other.minLevel;
-			} else {
-				return 1;
 			}
+			return 1;
 		} else {
 			if (minLevel == other.minLevel) return maxLevel - other.maxLevel;
-			else                            return minLevel - other.minLevel;
+			return minLevel - other.minLevel;
 		}
 	}
 }
-- 
cgit v1.2.3