1 /*
2 * Copyright (C) 2010, Google Inc.
3 * Copyright (C) 2010, Marc Strapetz <marc.strapetz@syntevo.com>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.treewalk.filter;
46
47 import org.eclipse.jgit.dircache.DirCacheEntry;
48 import org.eclipse.jgit.dircache.DirCacheIterator;
49 import org.eclipse.jgit.treewalk.TreeWalk;
50
51 /**
52 * To be used in combination with a DirCacheIterator: includes only tree entries
53 * for which 'skipWorkTree' flag is not set.
54 */
55 public class SkipWorkTreeFilter extends TreeFilter {
56
57 /** Index of DirCacheIterator to work on. */
58 private final int treeIdx;
59
60 /**
61 * Create a filter to work on the specified DirCacheIterator.
62 *
63 * @param treeIdx
64 * index of DirCacheIterator to work on. If the index does not
65 * refer to a DirCacheIterator, the filter will include all
66 * entries.
67 */
68 public SkipWorkTreeFilter(int treeIdx) {
69 this.treeIdx = treeIdx;
70 }
71
72 /** {@inheritDoc} */
73 @Override
74 public boolean include(TreeWalk walker) {
75 DirCacheIterator i = walker.getTree(treeIdx, DirCacheIterator.class);
76 if (i == null)
77 return true;
78
79 DirCacheEntry e = i.getDirCacheEntry();
80 return e == null || !e.isSkipWorkTree();
81 }
82
83 /** {@inheritDoc} */
84 @Override
85 public boolean shouldBeRecursive() {
86 return false;
87 }
88
89 /** {@inheritDoc} */
90 @Override
91 public TreeFilter clone() {
92 return this;
93 }
94
95 /** {@inheritDoc} */
96 @SuppressWarnings("nls")
97 @Override
98 public String toString() {
99 return "SkipWorkTree(" + treeIdx + ")";
100 }
101 }