/*
* Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.treewalk.filter;
import java.io.IOException;
import java.util.Collection;
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
import org.eclipse.jgit.errors.MissingObjectException;
import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.treewalk.TreeWalk;
/**
* Includes a tree entry only if all subfilters include the same tree entry.
* <p>
* Classic shortcut behavior is used, so evaluation of the
* {@link TreeFilter#include(TreeWalk)} method stops as soon as a false result
* is obtained. Applications can improve filtering performance by placing faster
* filters that are more likely to reject a result earlier in the list.
*/
public abstract class AndTreeFilter extends TreeFilter {
/**
* Create a filter with two filters, both of which must match.
*
* @param a
* first filter to test.
* @param b
* second filter to test.
* @return a filter that must match both input filters.
*/
public static TreeFilter create(final TreeFilter a, final TreeFilter b) {
if (a == ALL)
return b;
if (b == ALL)
return a;
return new Binary(a, b);
}
/**
* Create a filter around many filters, all of which must match.
*
* @param list
* list of filters to match against. Must contain at least 2
* filters.
* @return a filter that must match all input filters.
*/
public static TreeFilter create(final TreeFilter[] list) {
if (list.length == 2)
return create(list[0], list[1]);
if (list.length < 2)
throw new IllegalArgumentException(JGitText.get().atLeastTwoFiltersNeeded);
final TreeFilter[] subfilters = new TreeFilter[list.length];
System.arraycopy(list, 0, subfilters, 0, list.length);
return new List(subfilters);
}
/**
* Create a filter around many filters, all of which must match.
*
* @param list
* list of filters to match against. Must contain at least 2
* filters.
* @return a filter that must match all input filters.
*/
public static TreeFilter create(final Collection<TreeFilter> list) {
if (list.size() < 2)
throw new IllegalArgumentException(JGitText.get().atLeastTwoFiltersNeeded);
final TreeFilter[] subfilters = new TreeFilter[list.size()];
list.toArray(subfilters);
if (subfilters.length == 2)
return create(subfilters[0], subfilters[1]);
return new List(subfilters);
}
private static class Binary extends AndTreeFilter {
private final TreeFilter a;
private final TreeFilter b;
Binary(final TreeFilter one, final TreeFilter two) {
a = one;
b = two;
}
@Override
public boolean include(final TreeWalk walker)
throws MissingObjectException, IncorrectObjectTypeException,
IOException {
return a.include(walker) && b.include(walker);
}
@Override
public boolean shouldBeRecursive() {
return a.shouldBeRecursive() || b.shouldBeRecursive();
}
@Override
public TreeFilter clone() {
return new Binary(a.clone(), b.clone());
}
@SuppressWarnings("nls")
@Override
public String toString() {
return "(" + a.toString() + " AND " + b.toString() + ")";
}
}
private static class List extends AndTreeFilter {
private final TreeFilter[] subfilters;
List(final TreeFilter[] list) {
subfilters = list;
}
@Override
public boolean include(final TreeWalk walker)
throws MissingObjectException, IncorrectObjectTypeException,
IOException {
for (final TreeFilter f : subfilters) {
if (!f.include(walker))
return false;
}
return true;
}
@Override
public boolean shouldBeRecursive() {
for (final TreeFilter f : subfilters)
if (f.shouldBeRecursive())
return true;
return false;
}
@Override
public TreeFilter clone() {
final TreeFilter[] s = new TreeFilter[subfilters.length];
for (int i = 0; i < s.length; i++)
s[i] = subfilters[i].clone();
return new List(s);
}
@SuppressWarnings("nls")
@Override
public String toString() {
final StringBuilder r = new StringBuilder();
r.append("(");
for (int i = 0; i < subfilters.length; i++) {
if (i > 0)
r.append(" AND ");
r.append(subfilters[i].toString());
}
r.append(")");
return r.toString();
}
}
}