Improve error handling

Author: joelamos

src/com/joelchristophel/sourceradio/FileUtilities.java

@@ -23,26 +23,26 @@ private FileUtilities() {
 	 * @param includeBlankLines
 	 *            - indicates whether or not to include blank lines in list
 	 * @return the lines of the specified file or an empty list if the file was not found
+	 * @throws IOException
 	 */
-	static String[] getLines(String path, boolean includeBlankLines) {
+	static String[] getLines(String path, boolean includeBlankLines) throws IOException {
 		List<String> lines = new ArrayList<String>();
 		File file = new File(path);
 		if (file.exists()) {
-			try (BufferedReader reader = new BufferedReader(new FileReader(new File(path)));) {
-				String line = null;
-				while ((line = reader.readLine()) != null) {
-					if (!line.trim().isEmpty() || includeBlankLines) {
-						lines.add(line);
-					}
+			BufferedReader reader = new BufferedReader(new FileReader(new File(path)));
+			String line = null;
+			while ((line = reader.readLine()) != null) {
+				if (!line.trim().isEmpty() || includeBlankLines) {
+					lines.add(line);
 				}
-			} catch (IOException e) {
-				e.printStackTrace();
 			}
+			reader.close();
+
 		}
 		return lines.toArray(new String[] {});
 	}
 
-	static boolean fileHasLine(String path, String line, boolean commentAware) {
+	static boolean fileHasLine(String path, String line, boolean commentAware) throws IOException {
 		String[] lines = getLines(path, true);
 		boolean hasLine = false;
 		for (String fileLine : lines) {
@@ -61,8 +61,9 @@ static boolean fileHasLine(String path, String line, boolean commentAware) {
 	 *            - the path to a file
 	 * @param line
 	 *            - the line to append
+	 * @throws IOException 
 	 */
-	static void appendLine(String path, String line) {
+	static void appendLine(String path, String line) throws IOException {
 		trimFile(path);
 		line = line.startsWith(System.lineSeparator()) ? line : System.lineSeparator() + line;
 		try {
@@ -101,8 +102,9 @@ public void run() {
 	 * 
 	 * @param path
 	 *            - the path to a file
+	 * @throws IOException 
 	 */
-	static void trimFile(String path) {
+	static void trimFile(String path) throws IOException {
 		String[] lines = getLines(path, true);
 		int endingBlankLines = 0;
 		for (int i = lines.length - 1; i >= 0; i--) {
@@ -140,9 +142,10 @@ static void trimFile(String path) {
 	 *            - the line to remove
 	 * @param commentAware
 	 *            - indicates whether or not this method is aware that comments exist
+	 * @throws IOException 
 	 * @returns <code>true</code> if the file contained the line to begin with; <code>false</code> otherwise
 	 */
-	static boolean removeLine(String path, String line, boolean commentAware) {
+	static boolean removeLine(String path, String line, boolean commentAware) throws IOException {
 		boolean hasLine = fileHasLine(path, line, commentAware);
 		if (hasLine) {
 			String[] lines = getLines(path, true);

src/com/joelchristophel/sourceradio/Game.java

@@ -1,7 +1,7 @@
 package com.joelchristophel.sourceradio;
 
 import java.io.File;
-import java.io.FileNotFoundException;
+import java.io.IOException;
 
 enum Game {
 	TEAM_FORTRESS_2("Team Fortress 2", 440, "steamapps\\common\\Team Fortress 2\\tf\\", "hl2.exe", false, true,
@@ -12,7 +12,8 @@ enum Game {
 					StringResources.get("counterTerroristPattern"), " @ .+$" },
 			new String[] { "CS:GO", "CSGO", "Counterstrike", "Counter-Strike" }),
 	LEFT_4_DEAD_2("Left 4 Dead 2", 550, "steamapps\\common\\Left 4 Dead 2\\left4dead2\\", "left4dead2.exe", false,
-			false, new String[] { StringResources.get("survivorPattern") }, new String[] { "L4D2", "Left for Dead 2" });
+			false, new String[] { StringResources.get("survivorPattern") },
+			new String[] { "L4D2", "LFD2", "Left for Dead 2" });
 	private static Properties properties = Properties.getInstance();
 	private static Game currentGame;
 	private String friendlyName;
@@ -89,16 +90,23 @@ String getExeName() {
 		return exeName;
 	}
 
-	String getCfgPath() throws FileNotFoundException {
-		String steamId3 = properties.getOwner().getSteamId3();
-		String cfgPath = null;
-		if (cfgInUserdata) {
-			cfgPath = getSteamPath() + "userdata" + File.separator + steamId3 + File.separator + currentGame.id
-					+ File.separator + "local" + File.separator + "cfg" + File.separator;
-		} else {
-			cfgPath = currentGame.getPath() + "cfg" + File.separator;
+	String getCfgPath() throws IOException {
+		try {
+			String cfgPath = null;
+			String steamId3 = properties.getOwner().getSteamId3();
+			if (cfgInUserdata) {
+				cfgPath = getSteamPath() + "userdata" + File.separator + steamId3 + File.separator + currentGame.id
+						+ File.separator + "local" + File.separator + "cfg" + File.separator;
+			} else {
+				cfgPath = currentGame.getPath() + "cfg" + File.separator;
+			}
+			if (!new File(cfgPath).exists()) {
+				throw new IOException("Error: The game's expected cfg directory doesn't exist: " + cfgPath + ".");
+			}
+			return cfgPath;
+		} catch (IOException e) {
+			throw new IOException("Error: Failed to find the path to the game's cfg directory.", e);
 		}
-		return cfgPath;
 	}
 
 	boolean canChangeLog() {

src/com/joelchristophel/sourceradio/Playlist.java

@@ -1,12 +1,9 @@
 package com.joelchristophel.sourceradio;
 
-import java.io.BufferedReader;
 import java.io.Closeable;
 import java.io.File;
 import java.io.FileNotFoundException;
-import java.io.InputStreamReader;
-import java.net.HttpURLConnection;
-import java.net.URL;
+import java.io.IOException;
 import java.net.UnknownHostException;
 import java.sql.Types;
 import java.text.Normalizer;
@@ -64,7 +61,7 @@ public static void main(String[] args) {
 		System.out.println();
 		String version = Playlist.class.getPackage().getImplementationVersion();
 		version = version == null ? "" : version;
-		System.out.println("**** SourceRadio" + (version.isEmpty() ? "" : " v" + version)  + " ****");
+		System.out.println("**** SourceRadio" + (version.isEmpty() ? "" : " v" + version) + " ****");
 		System.out.println();
 		List<String> argsList = args == null ? new ArrayList<String>() : new ArrayList<String>(Arrays.asList(args));
 		if (argsList.contains("-d")) { // Restore default properties
@@ -121,7 +118,7 @@ public static void main(String[] args) {
 				Song.downloadYoutubedl("libraries");
 				System.out.println("Listening for commands...");
 				playlist.start();
-			} catch (FileNotFoundException e) { // If Steam or game directories don't exist
+			} catch (IOException e) {
 				System.out.println(e.getMessage());
 			}
 		}
@@ -131,9 +128,9 @@ public static void main(String[] args) {
 	 * This method is to be used to obtain a {@link Playlist} instance.
 	 * 
 	 * @return a <code>Playlist</code> instance
-	 * @throws FileNotFoundException
+	 * @throws IOException
 	 */
-	public synchronized static Playlist getInstance(Game game) throws FileNotFoundException {
+	public synchronized static Playlist getInstance(Game game) throws IOException {
 		Playlist playlist = null;
 		if (instance == null) {
 			playlist = (instance = new Playlist(game));
@@ -148,11 +145,11 @@ public synchronized static Playlist getInstance(Game game) throws FileNotFoundEx
 	/**
 	 * Constructs a {@link Playlist}.
 	 * 
-	 * @throws FileNotFoundException
+	 * @throws IOException
 	 * 
 	 * @see #getInstance
 	 */
-	private Playlist(Game game) throws FileNotFoundException {
+	private Playlist(Game game) throws IOException {
 		super();
 		this.game = game;
 		initialize();
@@ -161,9 +158,9 @@ private Playlist(Game game) throws FileNotFoundException {
 	/**
 	 * Starts the database, initializes instance variables, and writes key binds.
 	 * 
-	 * @throws FileNotFoundException
+	 * @throws IOException
 	 */
-	private void initialize() throws FileNotFoundException {
+	private void initialize() throws IOException {
 		Game.setCurrentGame(game);
 		logReader = LogReader.getInstance();
 		database = DatabaseManager.getInstance();
@@ -619,11 +616,7 @@ public void close() {
 	 */
 	private void setCurrentSong(Song song) {
 		currentSong = song;
-		try {
-			scriptWriter.updateCurrentSongScript(song);
-		} catch (FileNotFoundException e) {
-			System.err.println(e.getMessage());
-		}
+		scriptWriter.updateCurrentSongScript(song);
 	}
 
 	/**
@@ -787,7 +780,6 @@ private boolean removeAdmin(final Player adminToRemove, Player requester, boolea
 			success = admins.remove(adminToRemove);
 			if (toBeWritten) {
 				Runnable removeAdmin = new Runnable() {
-
 					@Override
 					public void run() {
 						properties.removeAdmin(adminToRemove);