v2, to allow for multiple instances

Author: TechnicJelle

README.md

@@ -5,17 +5,16 @@ A simple Java update checker for your application.
 Visit https://jitpack.io/#TechnicJelle/UpdateCheckerJava for details on how to install this library.
 
 ## Usage
-This library is very simple to use. Just call the `UpdateChecker.check()` method with your GitHub username,
-repository name and current version to check for updates.
+Simply instantiate a new `UpdateChecker` object with your GitHub username, repository name and current version.
 
-You can then log the update message with `UpdateChecker.logUpdateMessage()`.
+Then call `.check()` or `.checkAsync()` on the instance to check for updates.
 
-There is also an async way to check for updates: `UpdateChecker.checkAsync()`.
+You can then log the update message with `logUpdateMessage()`.
 
 ```java
-UpdateChecker.check("TechnicJelle", "UpdateChecker", "v1.0");
-
-UpdateChecker.logUpdateMessage(getLogger());
+UpdateChecker updateChecker = new UpdateChecker("TechnicJelle", "UpdateCheckerJava", "2.0");
+updateChecker.check();
+updateChecker.logUpdateMessage(getLogger());
 ```
 
-Full javadoc API reference: [technicjelle.com/UpdateCheckerJava](https://technicjelle.com/UpdateCheckerJava/com/technicjelle/UpdateChecker.html)
+Full javadoc API reference: [technicjelle.com/UpdateCheckerJava](https://technicjelle.com/UpdateCheckerJava/com/technicjelle/UpdateChecker.html)

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>com.technicjelle</groupId>
 	<artifactId>UpdateChecker</artifactId>
-	<version>1.0</version>
+	<version>2.0</version>
 
 	<properties>
 		<maven.compiler.source>11</maven.compiler.source>

src/main/java/com/technicjelle/UpdateChecker.java

@@ -6,31 +6,40 @@
 import java.io.IOException;
 import java.net.HttpURLConnection;
 import java.net.URL;
+import java.net.MalformedURLException;
 import java.util.logging.Logger;
 
 /**
  * Checks for updates on a GitHub repository
  */
-public final class UpdateChecker {
-	private static boolean updateAvailable = false;
-	private static URL url = null;
-	private static String latestVersion = null;
-	private static String curVer = null;
+public class UpdateChecker {
+	private final String repoName;
+	private final String currentVersion;
+	private final URL url;
+
+	private boolean updateAvailable = false;
+	private String latestVersion = null;
+
+	/**
+	 * @param author         GitHub Username
+	 * @param repoName       GitHub Repository Name
+	 * @param currentVersion Current version of the program. This must be in the same format as the version tags on GitHub
+	 * @throws MalformedURLException If the URL is invalid, due to an invalid author and/or name
+	 */
+	public UpdateChecker(@NotNull String author, @NotNull String repoName, @NotNull String currentVersion) throws MalformedURLException {
+		this.repoName = repoName;
+		this.currentVersion = removePrefix(currentVersion);
+		this.url = new URL("https://github.com/" + author + "/" + repoName + "/releases/latest");
+	}
 
 	/**
 	 * Checks for updates from a GitHub repository's releases<br>
 	 * <i>This method blocks the thread it is called from</i>
 	 *
-	 * @param author         GitHub Username
-	 * @param name           GitHub Repository Name
-	 * @param currentVersion Current version of the program. This must be in the same format as the version tags on GitHub
 	 * @throws IOException If an IO exception occurs
-	 * @see #checkAsync(String, String, String)
+	 * @see #checkAsync()
 	 */
-	public static void check(@NotNull String author, @NotNull String name, @NotNull String currentVersion) throws IOException {
-		curVer = removePrefix(currentVersion);
-		url = new URL("https://github.com/" + author + "/" + name + "/releases/latest");
-
+	public void check() throws IOException {
 		// Connect to GitHub website
 		HttpURLConnection con;
 		con = (HttpURLConnection) url.openConnection();
@@ -48,39 +57,35 @@ public static void check(@NotNull String author, @NotNull String name, @NotNull
 		latestVersion = removePrefix(split[split.length - 1]);
 
 		// Check if the latest version is not the current version
-		if (!latestVersion.equals(curVer)) updateAvailable = true;
+		if (!latestVersion.equals(currentVersion)) updateAvailable = true;
 	}
 
 	/**
 	 * Checks for updates from a GitHub repository's releases<br>
 	 * <i>This method does not block the thread it is called from</i>
 	 *
-	 * @param author         GitHub Username
-	 * @param name           GitHub Repository Name
-	 * @param currentVersion Current version of the program. This must be in the same format as the version tags on GitHub
-	 * @see #check(String, String, String)
+	 * @see #check()
 	 */
-	public static void checkAsync(@NotNull String author, @NotNull String name, @NotNull String currentVersion) {
-		curVer = removePrefix(currentVersion);
+	public void checkAsync() {
 		new Thread(() -> {
 			try {
-				check(author, name, currentVersion);
+				check();
 			} catch (IOException e) {
 				throw new RuntimeException(e);
 			}
-		}, name + "-Update-Checker").start();
+		}, repoName + "-Update-Checker").start();
 	}
 
 	/**
 	 * This method logs a message to the console if an update is available<br>
 	 *
 	 * @param logger Logger to log a potential update notification to
-	 * @throws IllegalStateException If {@link #check(String, String, String)} has not been called
+	 * @throws IllegalStateException If {@link #check()} has not been called
 	 */
-	public static void logUpdateMessage(Logger logger) throws IllegalStateException {
-		if (curVer == null) throw new IllegalStateException("UpdateChecker.check() has not been called");
+	public void logUpdateMessage(@NotNull Logger logger) throws IllegalStateException {
+		if (latestVersion == null) throw new IllegalStateException("check() has not been called");
 		if (updateAvailable) {
-			logger.warning("New version available: v" + latestVersion + " (current: v" + curVer + ")");
+			logger.warning("New version available: v" + latestVersion + " (current: v" + currentVersion + ")");
 			logger.warning("Download it at " + url);
 		}
 	}
@@ -95,8 +100,4 @@ public static void logUpdateMessage(Logger logger) throws IllegalStateException
 	private static @NotNull String removePrefix(@NotNull String version) {
 		return version.replaceFirst("^v", "");
 	}
-
-	private UpdateChecker() {
-		throw new IllegalStateException("Utility class");
-	}
 }