1 /* 2 * Copyright (C) 2008, Google Inc. 3 * Copyright (C) 2008, Jonas Fonseca <fonseca@diku.dk> 4 * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com> 5 * Copyright (C) 2006-2007, Shawn O. Pearce <spearce@spearce.org> 6 * and other copyright owners as documented in the project's IP log. 7 * 8 * This program and the accompanying materials are made available 9 * under the terms of the Eclipse Distribution License v1.0 which 10 * accompanies this distribution, is reproduced below, and is 11 * available at http://www.eclipse.org/org/documents/edl-v10.php 12 * 13 * All rights reserved. 14 * 15 * Redistribution and use in source and binary forms, with or 16 * without modification, are permitted provided that the following 17 * conditions are met: 18 * 19 * - Redistributions of source code must retain the above copyright 20 * notice, this list of conditions and the following disclaimer. 21 * 22 * - Redistributions in binary form must reproduce the above 23 * copyright notice, this list of conditions and the following 24 * disclaimer in the documentation and/or other materials provided 25 * with the distribution. 26 * 27 * - Neither the name of the Eclipse Foundation, Inc. nor the 28 * names of its contributors may be used to endorse or promote 29 * products derived from this software without specific prior 30 * written permission. 31 * 32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 33 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 34 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 35 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 36 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 37 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 39 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 40 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 41 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 43 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 44 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 45 */ 46 47 package org.eclipse.jgit.errors; 48 49 import java.io.IOException; 50 import java.text.MessageFormat; 51 52 import org.eclipse.jgit.annotations.Nullable; 53 import org.eclipse.jgit.internal.JGitText; 54 import org.eclipse.jgit.lib.AnyObjectId; 55 import org.eclipse.jgit.lib.ObjectChecker; 56 import org.eclipse.jgit.lib.ObjectId; 57 58 /** 59 * Exception thrown when an object cannot be read from Git. 60 */ 61 public class CorruptObjectException extends IOException { 62 private static final long serialVersionUID = 1L; 63 64 private ObjectChecker.ErrorType errorType; 65 66 /** 67 * Report a specific error condition discovered in an object. 68 * 69 * @param type 70 * type of error 71 * @param id 72 * identity of the bad object 73 * @param why 74 * description of the error. 75 * @since 4.2 76 */ 77 public CorruptObjectException(ObjectChecker.ErrorType type, AnyObjectId id, 78 String why) { 79 super(MessageFormat.format(JGitText.get().objectIsCorrupt3, 80 type.getMessageId(), id.name(), why)); 81 this.errorType = type; 82 } 83 84 /** 85 * Construct a CorruptObjectException for reporting a problem specified 86 * object id 87 * 88 * @param id 89 * a {@link org.eclipse.jgit.lib.AnyObjectId} 90 * @param why 91 * error message 92 */ 93 public CorruptObjectException(AnyObjectId id, String why) { 94 super(MessageFormat.format(JGitText.get().objectIsCorrupt, id.name(), why)); 95 } 96 97 /** 98 * Construct a CorruptObjectException for reporting a problem specified 99 * object id 100 * 101 * @param id 102 * a {@link org.eclipse.jgit.lib.ObjectId} 103 * @param why 104 * error message 105 */ 106 public CorruptObjectException(ObjectId id, String why) { 107 super(MessageFormat.format(JGitText.get().objectIsCorrupt, id.name(), why)); 108 } 109 110 /** 111 * Construct a CorruptObjectException for reporting a problem not associated 112 * with a specific object id. 113 * 114 * @param why 115 * error message 116 */ 117 public CorruptObjectException(String why) { 118 super(why); 119 } 120 121 /** 122 * Construct a CorruptObjectException for reporting a problem not associated 123 * with a specific object id. 124 * 125 * @param why 126 * message describing the corruption. 127 * @param cause 128 * optional root cause exception 129 * @since 3.4 130 */ 131 public CorruptObjectException(String why, Throwable cause) { 132 super(why); 133 initCause(cause); 134 } 135 136 /** 137 * Specific error condition identified by 138 * {@link org.eclipse.jgit.lib.ObjectChecker}. 139 * 140 * @return error condition or null. 141 * @since 4.2 142 */ 143 @Nullable 144 public ObjectChecker.ErrorType getErrorType() { 145 return errorType; 146 } 147 }