1 /*
2 * Copyright (C) 2010, Google Inc.
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.errors;
45
46 import java.io.IOException;
47 import java.text.MessageFormat;
48 import java.util.Collection;
49
50 import org.eclipse.jgit.internal.JGitText;
51 import org.eclipse.jgit.lib.AbbreviatedObjectId;
52 import org.eclipse.jgit.lib.ObjectId;
53
54 /** An {@link AbbreviatedObjectId} cannot be extended. */
55 public class AmbiguousObjectException extends IOException {
56 private static final long serialVersionUID = 1L;
57
58 private final AbbreviatedObjectId missing;
59
60 private final Collection<ObjectId> candidates;
61
62 /**
63 * Construct a MissingObjectException for the specified object id. Expected
64 * type is reported to simplify tracking down the problem.
65 *
66 * @param id
67 * SHA-1
68 * @param candidates
69 * the candidate matches returned by the ObjectReader.
70 */
71 public AmbiguousObjectException(final AbbreviatedObjectId id,
72 final Collection<ObjectId> candidates) {
73 super(MessageFormat.format(JGitText.get().ambiguousObjectAbbreviation,
74 id.name()));
75 this.missing = id;
76 this.candidates = candidates;
77 }
78
79 /** @return the AbbreviatedObjectId that has more than one result. */
80 public AbbreviatedObjectId getAbbreviatedObjectId() {
81 return missing;
82 }
83
84 /** @return the matching candidates (or at least a subset of them). */
85 public Collection<ObjectId> getCandidates() {
86 return candidates;
87 }
88 }