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