AmbiguousObjectException.java

/*
 * Copyright (C) 2010, Google Inc.
 * 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.errors;

import java.io.IOException;
import java.text.MessageFormat;
import java.util.Collection;

import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.lib.AbbreviatedObjectId;
import org.eclipse.jgit.lib.ObjectId;

/**
 * An {@link org.eclipse.jgit.lib.AbbreviatedObjectId} cannot be extended.
 */
public class AmbiguousObjectException extends IOException {
    private static final long serialVersionUID = 1L;

    private final AbbreviatedObjectId missing;

    private final Collection<ObjectId> candidates;

    /**
     * Construct a MissingObjectException for the specified object id. Expected
     * type is reported to simplify tracking down the problem.
     *
     * @param id
     *            SHA-1
     * @param candidates
     *            the candidate matches returned by the ObjectReader.
     */
    public AmbiguousObjectException(final AbbreviatedObjectId id,
            final Collection<ObjectId> candidates) {
        super(MessageFormat.format(JGitText.get().ambiguousObjectAbbreviation,
                id.name()));
        this.missing = id;
        this.candidates = candidates;
    }

    /**
     * Get the {@code AbbreviatedObjectId} that has more than one result
     *
     * @return the {@code AbbreviatedObjectId} that has more than one result
     */
    public AbbreviatedObjectId getAbbreviatedObjectId() {
        return missing;
    }

    /**
     * Get the matching candidates (or at least a subset of them)
     *
     * @return the matching candidates (or at least a subset of them)
     */
    public Collection<ObjectId> getCandidates() {
        return candidates;
    }
}