1 /*
2 * Copyright (C) 2017, Google 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
44 package org.eclipse.jgit.errors;
45
46 import org.eclipse.jgit.annotations.Nullable;
47
48 /**
49 * Exception thrown when encounters a corrupt pack index file.
50 *
51 * @since 4.9
52 */
53 public class CorruptPackIndexException extends Exception {
54 private static final long serialVersionUID = 1L;
55
56 /** The error type of a corrupt index file. */
57 public enum ErrorType {
58 /** Offset does not match index in pack file. */
59 MISMATCH_OFFSET,
60 /** CRC does not match CRC of the object data in pack file. */
61 MISMATCH_CRC,
62 /** CRC is not present in index file. */
63 MISSING_CRC,
64 /** Object in pack is not present in index file. */
65 MISSING_OBJ,
66 /** Object in index file is not present in pack file. */
67 UNKNOWN_OBJ,
68 }
69
70 private ErrorType errorType;
71
72 /**
73 * Report a specific error condition discovered in an index file.
74 *
75 * @param message
76 * the error message.
77 * @param errorType
78 * the error type of corruption.
79 */
80 public CorruptPackIndexException(String message, ErrorType errorType) {
81 super(message);
82 this.errorType = errorType;
83 }
84
85 /**
86 * Specific the reason of the corrupt index file.
87 *
88 * @return error condition or null.
89 */
90 @Nullable
91 public ErrorType getErrorType() {
92 return errorType;
93 }
94 }