1 /*
2 * Copyright (C) 2019, Google LLC.
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.revwalk;
44
45 import java.io.IOException;
46 import java.util.Collection;
47 import java.util.Optional;
48
49 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
50 import org.eclipse.jgit.errors.MissingObjectException;
51
52 /**
53 * Check if a commit is reachable from a collection of starting commits.
54 * <p>
55 * Note that this checks the reachability of commits (and tags). Trees, blobs or
56 * any other object will cause IncorrectObjectTypeException exceptions.
57 *
58 * @since 5.4
59 */
60 public interface ReachabilityChecker {
61
62 /**
63 * Check if all targets are reachable from the {@code starter} commits.
64 * <p>
65 * Caller should parse the objectIds (preferably with
66 * {@code walk.parseCommit()} and handle missing/incorrect type objects
67 * before calling this method.
68 *
69 * @param targets
70 * commits to reach.
71 * @param starters
72 * known starting points.
73 * @return An unreachable target if at least one of the targets is
74 * unreachable. An empty optional if all targets are reachable from
75 * the starters.
76 *
77 * @throws MissingObjectException
78 * if any of the incoming objects doesn't exist in the
79 * repository.
80 * @throws IncorrectObjectTypeException
81 * if any of the incoming objects is not a commit or a tag.
82 * @throws IOException
83 * if any of the underlying indexes or readers can not be
84 * opened.
85 */
86 Optional<RevCommit> areAllReachable(Collection<RevCommit> targets,
87 Collection<RevCommit> starters)
88 throws MissingObjectException, IncorrectObjectTypeException,
89 IOException;
90 }