jgit/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/errors/CorruptLongObjectException.java

/*
 * Copyright (C) 2015, Matthias Sohn <matthias.sohn@sap.com>
 * and other copyright owners as documented in the project's IP log.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.eclipse.jgit.lfs.errors;

import org.eclipse.jgit.lfs.lib.AnyLongObjectId;

/**
 * Thrown when an object id is given that doesn't match the hash of the object's
 * content
 *
 * @since 4.3
 */
public class CorruptLongObjectException extends IllegalArgumentException {

	private static final long serialVersionUID = 1L;

	private final AnyLongObjectId id;

	private final AnyLongObjectId contentHash;

	/**
	 * Corrupt long object detected.
	 *
	 * @param id
	 *            id of the long object
	 * @param contentHash
	 *            hash of the long object's content
	 *
	 * @param message
	 */
	public CorruptLongObjectException(AnyLongObjectId id,
			AnyLongObjectId contentHash,
			String message) {
		super(message);
		this.id = id;
		this.contentHash = contentHash;
	}

	/**
	 * @return the id of the object, i.e. the expected hash of the object's
	 *         content
	 */
	public AnyLongObjectId getId() {
		return id;
	}

	/**
	 * @return the actual hash of the object's content which doesn't match the
	 *         object's id when this exception is thrown which signals that the
	 *         object has been corrupted
	 */
	public AnyLongObjectId getContentHash() {
		return contentHash;
	}
}