1 /*
2 * Copyright (C) 2010, Jens Baumgart <jens.baumgart@sap.com>
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 package org.eclipse.jgit.treewalk.filter;
44
45 import java.io.IOException;
46
47 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
48 import org.eclipse.jgit.errors.MissingObjectException;
49 import org.eclipse.jgit.treewalk.TreeWalk;
50 import org.eclipse.jgit.treewalk.WorkingTreeIterator;
51
52 /**
53 * Skip {@link org.eclipse.jgit.treewalk.WorkingTreeIterator} entries that
54 * appear in gitignore files.
55 */
56 public class NotIgnoredFilter extends TreeFilter {
57 private final int index;
58
59 /**
60 * Construct a filter to ignore paths known to a particular iterator.
61 *
62 * @param workdirTreeIndex
63 * index of the workdir tree in the tree walk
64 */
65 public NotIgnoredFilter(int workdirTreeIndex) {
66 this.index = workdirTreeIndex;
67 }
68
69 /** {@inheritDoc} */
70 @Override
71 public boolean include(TreeWalk tw) throws MissingObjectException,
72 IncorrectObjectTypeException, IOException {
73 WorkingTreeIterator i = tw.getTree(index, WorkingTreeIterator.class);
74 return i == null || !i.isEntryIgnored();
75 }
76
77 /** {@inheritDoc} */
78 @Override
79 public boolean shouldBeRecursive() {
80 return false;
81 }
82
83 /** {@inheritDoc} */
84 @Override
85 public TreeFilter clone() {
86 // immutable
87 return this;
88 }
89
90 /** {@inheritDoc} */
91 @SuppressWarnings("nls")
92 @Override
93 public String toString() {
94 return "NotIgnored(" + index + ")";
95 }
96 }