View Javadoc
1   /*
2    * Copyright (C) 2015, Matthias Sohn <matthias.sohn@sap.com>
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.lfs.errors;
45  
46  import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
47  
48  /**
49   * Thrown when an object id is given that doesn't match the hash of the object's
50   * content
51   *
52   * @since 4.3
53   */
54  public class CorruptLongObjectException extends IllegalArgumentException {
55  
56  	private static final long serialVersionUID = 1L;
57  
58  	private final AnyLongObjectId id;
59  
60  	private final AnyLongObjectId contentHash;
61  
62  	/**
63  	 * Corrupt long object detected.
64  	 *
65  	 * @param id
66  	 *            id of the long object
67  	 * @param contentHash
68  	 *            hash of the long object's content
69  	 * @param message a {@link java.lang.String} object.
70  	 */
71  	public CorruptLongObjectException(AnyLongObjectId id,
72  			AnyLongObjectId contentHash,
73  			String message) {
74  		super(message);
75  		this.id = id;
76  		this.contentHash = contentHash;
77  	}
78  
79  	/**
80  	 * Get the <code>id</code> of the object.
81  	 *
82  	 * @return the id of the object, i.e. the expected hash of the object's
83  	 *         content
84  	 */
85  	public AnyLongObjectId getId() {
86  		return id;
87  	}
88  
89  	/**
90  	 * Get the <code>contentHash</code>.
91  	 *
92  	 * @return the actual hash of the object's content which doesn't match the
93  	 *         object's id when this exception is thrown which signals that the
94  	 *         object has been corrupted
95  	 */
96  	public AnyLongObjectId getContentHash() {
97  		return contentHash;
98  	}
99  }