diff src/org/tmatesoft/hg/core/HgIOException.java @ 498:0205a5c4566b

Issue 38: preserve user formatting and comments when updating configuration files
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Fri, 26 Oct 2012 18:17:15 +0200
parents
children 7c0d2ce340b8
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/org/tmatesoft/hg/core/HgIOException.java	Fri Oct 26 18:17:15 2012 +0200
@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2012 TMate Software Ltd
+ *  
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * For information on how to redistribute this software under
+ * the terms of a license other than GNU General Public License
+ * contact TMate Software at support@hg4j.com
+ */
+package org.tmatesoft.hg.core;
+
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * Tailored wrap for {@link IOException} and similar I/O-related issues. Unlike {@link IOException}, 
+ * keeps track of {@link File} that caused the problem. Besides, additional information (like revision, 
+ * see {@link HgException}) may be attached.
+ * 
+ * @author Artem Tikhomirov
+ * @author TMate Software Ltd.
+ */
+@SuppressWarnings("serial")
+public class HgIOException extends HgException {
+	private final File file;
+
+	public HgIOException(String message, File troubleFile) {
+		this(message, null, troubleFile);
+	}
+
+	/**
+	 * @param message describes the issue, never <code>null</code>
+	 * @param cause root cause for the error, likely {@link IOException} or its subclass, but not necessarily, and may be omitted. 
+	 * @param troubleFile file we tried to deal with, never <code>null</code>
+	 */
+	public HgIOException(String message, Exception cause, File troubleFile) {
+		super(message, cause);
+		file = troubleFile;
+	}
+
+	public File getFile() {
+		return file;
+	}
+}