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