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