1 /* 2 * Copyright (C) 2011, GitHub Inc. 3 * and other copyright owners as documented in the project's IP log. 4 * 5 * This program and the accompanying materials are made available 6 * under the terms of the Eclipse Distribution License v1.0 which 7 * accompanies this distribution, is reproduced below, and is 8 * available at http://www.eclipse.org/org/documents/edl-v10.php 9 * 10 * All rights reserved. 11 * 12 * Redistribution and use in source and binary forms, with or 13 * without modification, are permitted provided that the following 14 * conditions are met: 15 * 16 * - Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 19 * - Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials provided 22 * with the distribution. 23 * 24 * - Neither the name of the Eclipse Foundation, Inc. nor the 25 * names of its contributors may be used to endorse or promote 26 * products derived from this software without specific prior 27 * written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 42 */ 43 package org.eclipse.jgit.errors; 44 45 import java.io.File; 46 import java.io.IOException; 47 import java.text.MessageFormat; 48 49 import org.eclipse.jgit.internal.JGitText; 50 51 /** 52 * An exception occurring when a file cannot be locked 53 */ 54 public class LockFailedException extends IOException { 55 private static final long serialVersionUID = 1L; 56 57 private File file; 58 59 /** 60 * Constructor for LockFailedException 61 * 62 * @param file 63 * file that could not be locked 64 * @param message 65 * exception message 66 * @param cause 67 * cause, for later retrieval by 68 * {@link java.lang.Throwable#getCause()} 69 * @since 4.1 70 */ 71 public LockFailedException(File file, String message, Throwable cause) { 72 super(message, cause); 73 this.file = file; 74 } 75 76 /** 77 * Construct a CannotLockException for the given file and message 78 * 79 * @param file 80 * file that could not be locked 81 * @param message 82 * exception message 83 */ 84 public LockFailedException(File file, String message) { 85 super(message); 86 this.file = file; 87 } 88 89 /** 90 * Construct a CannotLockException for the given file 91 * 92 * @param file 93 * file that could not be locked 94 */ 95 public LockFailedException(File file) { 96 this(file, MessageFormat.format(JGitText.get().cannotLock, file)); 97 } 98 99 /** 100 * Get the file that could not be locked 101 * 102 * @return file 103 */ 104 public File getFile() { 105 return file; 106 } 107 }