1 /*
2 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
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.revwalk;
45
46 import java.text.MessageFormat;
47
48 import org.eclipse.jgit.internal.JGitText;
49
50 /**
51 * Application level mark bit for {@link org.eclipse.jgit.revwalk.RevObject}s.
52 * <p>
53 * To create a flag use
54 * {@link org.eclipse.jgit.revwalk.RevWalk#newFlag(String)}.
55 */
56 public class RevFlag {
57 /**
58 * Uninteresting by {@link RevWalk#markUninteresting(RevCommit)}.
59 * <p>
60 * We flag commits as uninteresting if the caller does not want commits
61 * reachable from a commit to {@link RevWalk#markUninteresting(RevCommit)}.
62 * This flag is always carried into the commit's parents and is a key part
63 * of the "rev-list B --not A" feature; A is marked UNINTERESTING.
64 * <p>
65 * This is a static flag. Its RevWalk is not available.
66 */
67 public static final RevFlag UNINTERESTING = new StaticRevFlag(
68 "UNINTERESTING", RevWalk.UNINTERESTING); //$NON-NLS-1$
69
70 /**
71 * Set on RevCommit instances added to {@link RevWalk#pending} queue.
72 * <p>
73 * We use this flag to avoid adding the same commit instance twice to our
74 * queue, especially if we reached it by more than one path.
75 * <p>
76 * This is a static flag. Its RevWalk is not available.
77 *
78 * @since 3.0
79 */
80 public static final RevFlag SEEN = new StaticRevFlag("SEEN", RevWalk.SEEN); //$NON-NLS-1$
81
82 final RevWalk walker;
83
84 final String name;
85
86 final int mask;
87
88 RevFlag(RevWalk w, String n, int m) {
89 walker = w;
90 name = n;
91 mask = m;
92 }
93
94 /**
95 * Get the revision walk instance this flag was created from.
96 *
97 * @return the walker this flag was allocated out of, and belongs to.
98 */
99 public RevWalk getRevWalk() {
100 return walker;
101 }
102
103 /** {@inheritDoc} */
104 @Override
105 public String toString() {
106 return name;
107 }
108
109 static class StaticRevFlag extends RevFlag {
110 StaticRevFlag(String n, int m) {
111 super(null, n, m);
112 }
113
114 @Override
115 public RevWalk getRevWalk() {
116 throw new UnsupportedOperationException(MessageFormat.format(
117 JGitText.get().isAStaticFlagAndHasNorevWalkInstance, toString()));
118 }
119 }
120 }