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.filter;
45
46 import java.io.IOException;
47
48 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
49 import org.eclipse.jgit.errors.MissingObjectException;
50 import org.eclipse.jgit.revwalk.RevCommit;
51 import org.eclipse.jgit.revwalk.RevFlag;
52 import org.eclipse.jgit.revwalk.RevFlagSet;
53 import org.eclipse.jgit.revwalk.RevWalk;
54
55 /** Matches only commits with some/all RevFlags already set. */
56 public abstract class RevFlagFilter extends RevFilter {
57 /**
58 * Create a new filter that tests for a single flag.
59 *
60 * @param a
61 * the flag to test.
62 * @return filter that selects only commits with flag <code>a</code>.
63 */
64 public static RevFilter has(final RevFlag a) {
65 final RevFlagSet s = new RevFlagSet();
66 s.add(a);
67 return new HasAll(s);
68 }
69
70 /**
71 * Create a new filter that tests all flags in a set.
72 *
73 * @param a
74 * set of flags to test.
75 * @return filter that selects only commits with all flags in <code>a</code>.
76 */
77 public static RevFilter hasAll(final RevFlag... a) {
78 final RevFlagSet set = new RevFlagSet();
79 for (final RevFlag flag : a)
80 set.add(flag);
81 return new HasAll(set);
82 }
83
84 /**
85 * Create a new filter that tests all flags in a set.
86 *
87 * @param a
88 * set of flags to test.
89 * @return filter that selects only commits with all flags in <code>a</code>.
90 */
91 public static RevFilter hasAll(final RevFlagSet a) {
92 return new HasAll(new RevFlagSet(a));
93 }
94
95 /**
96 * Create a new filter that tests for any flag in a set.
97 *
98 * @param a
99 * set of flags to test.
100 * @return filter that selects only commits with any flag in <code>a</code>.
101 */
102 public static RevFilter hasAny(final RevFlag... a) {
103 final RevFlagSet set = new RevFlagSet();
104 for (final RevFlag flag : a)
105 set.add(flag);
106 return new HasAny(set);
107 }
108
109 /**
110 * Create a new filter that tests for any flag in a set.
111 *
112 * @param a
113 * set of flags to test.
114 * @return filter that selects only commits with any flag in <code>a</code>.
115 */
116 public static RevFilter hasAny(final RevFlagSet a) {
117 return new HasAny(new RevFlagSet(a));
118 }
119
120 final RevFlagSet flags;
121
122 RevFlagFilter(final RevFlagSet m) {
123 flags = m;
124 }
125
126 @Override
127 public RevFilter clone() {
128 return this;
129 }
130
131 @Override
132 public String toString() {
133 return super.toString() + flags;
134 }
135
136 private static class HasAll extends RevFlagFilter {
137 HasAll(final RevFlagSet m) {
138 super(m);
139 }
140
141 @Override
142 public boolean include(final RevWalk walker, final RevCommit c)
143 throws MissingObjectException, IncorrectObjectTypeException,
144 IOException {
145 return c.hasAll(flags);
146 }
147
148 @Override
149 public boolean requiresCommitBody() {
150 return false;
151 }
152 }
153
154 private static class HasAny extends RevFlagFilter {
155 HasAny(final RevFlagSet m) {
156 super(m);
157 }
158
159 @Override
160 public boolean include(final RevWalk walker, final RevCommit c)
161 throws MissingObjectException, IncorrectObjectTypeException,
162 IOException {
163 return c.hasAny(flags);
164 }
165
166 @Override
167 public boolean requiresCommitBody() {
168 return false;
169 }
170 }
171 }