View Javadoc
1   /*
2    * Copyright (C) 2009, Google Inc.
3    * Copyright (C) 2008, Jonas Fonseca <fonseca@diku.dk>
4    * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
5    * Copyright (C) 2006-2007, Shawn O. Pearce <spearce@spearce.org>
6    * and other copyright owners as documented in the project's IP log.
7    *
8    * This program and the accompanying materials are made available
9    * under the terms of the Eclipse Distribution License v1.0 which
10   * accompanies this distribution, is reproduced below, and is
11   * available at http://www.eclipse.org/org/documents/edl-v10.php
12   *
13   * All rights reserved.
14   *
15   * Redistribution and use in source and binary forms, with or
16   * without modification, are permitted provided that the following
17   * conditions are met:
18   *
19   * - Redistributions of source code must retain the above copyright
20   *   notice, this list of conditions and the following disclaimer.
21   *
22   * - Redistributions in binary form must reproduce the above
23   *   copyright notice, this list of conditions and the following
24   *   disclaimer in the documentation and/or other materials provided
25   *   with the distribution.
26   *
27   * - Neither the name of the Eclipse Foundation, Inc. nor the
28   *   names of its contributors may be used to endorse or promote
29   *   products derived from this software without specific prior
30   *   written permission.
31   *
32   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
33   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
34   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
37   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
40   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
41   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
44   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45   */
46  
47  package org.eclipse.jgit.errors;
48  
49  import java.io.IOException;
50  import java.text.MessageFormat;
51  
52  import org.eclipse.jgit.internal.JGitText;
53  import org.eclipse.jgit.lib.AbbreviatedObjectId;
54  import org.eclipse.jgit.lib.Constants;
55  import org.eclipse.jgit.lib.ObjectId;
56  
57  /**
58   * An expected object is missing.
59   */
60  public class MissingObjectException extends IOException {
61  	private static final long serialVersionUID = 1L;
62  
63  	private final ObjectId missing;
64  
65  	/**
66  	 * Construct a MissingObjectException for the specified object id.
67  	 * Expected type is reported to simplify tracking down the problem.
68  	 *
69  	 * @param id SHA-1
70  	 * @param type object type
71  	 */
72  	public MissingObjectException(ObjectId id, String type) {
73  		super(MessageFormat.format(JGitText.get().missingObject, type, id.name()));
74  		missing = id.copy();
75  	}
76  
77  	/**
78  	 * Construct a MissingObjectException for the specified object id.
79  	 * Expected type is reported to simplify tracking down the problem.
80  	 *
81  	 * @param id SHA-1
82  	 * @param type object type
83  	 */
84  	public MissingObjectException(ObjectId id, int type) {
85  		this(id, Constants.typeString(type));
86  	}
87  
88  	/**
89  	 * Construct a MissingObjectException for the specified object id. Expected
90  	 * type is reported to simplify tracking down the problem.
91  	 *
92  	 * @param id
93  	 *            SHA-1
94  	 * @param type
95  	 *            object type
96  	 */
97  	public MissingObjectException(AbbreviatedObjectId id, int type) {
98  		super(MessageFormat.format(JGitText.get().missingObject, Constants
99  				.typeString(type), id.name()));
100 		missing = null;
101 	}
102 
103 	/**
104 	 * Get the ObjectId that was not found
105 	 *
106 	 * @return the ObjectId that was not found
107 	 */
108 	public ObjectId getObjectId() {
109 		return missing;
110 	}
111 }