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

/*
 * Copyright (C) 2016, Christian Halstrick <christian.halstrick@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 java.io.IOException;
import java.nio.file.Path;
import java.text.MessageFormat;

import org.eclipse.jgit.lfs.internal.LfsText;

/**
 * Thrown when a LFS mediafile is found which doesn't have the expected size
 *
 * @since 4.6
 */
public class CorruptMediaFile extends IOException {
	private static final long serialVersionUID = 1L;

	private Path mediaFile;

	private long expectedSize;

	private long size;

	/**
	 * <p>Constructor for CorruptMediaFile.</p>
	 *
	 * @param mediaFile a {@link java.nio.file.Path} object.
	 * @param expectedSize a long.
	 * @param size a long.
	 */
	@SuppressWarnings("boxing")
	public CorruptMediaFile(Path mediaFile, long expectedSize,
			long size) {
		super(MessageFormat.format(LfsText.get().inconsistentMediafileLength,
				mediaFile, expectedSize, size));
		this.mediaFile = mediaFile;
		this.expectedSize = expectedSize;
		this.size = size;
	}

	/**
	 * Get the <code>mediaFile</code>.
	 *
	 * @return the media file which seems to be corrupt
	 */
	public Path getMediaFile() {
		return mediaFile;
	}

	/**
	 * Get the <code>expectedSize</code>.
	 *
	 * @return the expected size of the media file
	 */
	public long getExpectedSize() {
		return expectedSize;
	}

	/**
	 * Get the <code>size</code>.
	 *
	 * @return the actual size of the media file in the file system
	 */
	public long getSize() {
		return size;
	}
}