View Javadoc
1   /*
2    * Copyright (C) 2016, Christian Halstrick <christian.halstrick@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  package org.eclipse.jgit.lfs.errors;
44  
45  import java.io.IOException;
46  import java.nio.file.Path;
47  import java.text.MessageFormat;
48  
49  import org.eclipse.jgit.lfs.internal.LfsText;
50  
51  /**
52   * Thrown when a LFS mediafile is found which doesn't have the expected size
53   *
54   * @since 4.6
55   */
56  public class CorruptMediaFile extends IOException {
57  	private static final long serialVersionUID = 1L;
58  
59  	private Path mediaFile;
60  
61  	private long expectedSize;
62  
63  	private long size;
64  
65  	/**
66  	 * <p>Constructor for CorruptMediaFile.</p>
67  	 *
68  	 * @param mediaFile a {@link java.nio.file.Path} object.
69  	 * @param expectedSize a long.
70  	 * @param size a long.
71  	 */
72  	@SuppressWarnings("boxing")
73  	public CorruptMediaFile(Path mediaFile, long expectedSize,
74  			long size) {
75  		super(MessageFormat.format(LfsText.get().inconsistentMediafileLength,
76  				mediaFile, expectedSize, size));
77  		this.mediaFile = mediaFile;
78  		this.expectedSize = expectedSize;
79  		this.size = size;
80  	}
81  
82  	/**
83  	 * Get the <code>mediaFile</code>.
84  	 *
85  	 * @return the media file which seems to be corrupt
86  	 */
87  	public Path getMediaFile() {
88  		return mediaFile;
89  	}
90  
91  	/**
92  	 * Get the <code>expectedSize</code>.
93  	 *
94  	 * @return the expected size of the media file
95  	 */
96  	public long getExpectedSize() {
97  		return expectedSize;
98  	}
99  
100 	/**
101 	 * Get the <code>size</code>.
102 	 *
103 	 * @return the actual size of the media file in the file system
104 	 */
105 	public long getSize() {
106 		return size;
107 	}
108 }