1 /*
2 * Copyright (C) 2009, Google Inc.
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.treewalk.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.internal.JGitText;
51 import org.eclipse.jgit.lib.Constants;
52 import org.eclipse.jgit.treewalk.TreeWalk;
53
54 /**
55 * Includes tree entries only if they end with the configured path (suffix
56 * match).
57 * <p>
58 * For example, <code>PathSuffixFilter.create(".txt")</code> will match all
59 * paths ending in <code>.txt</code>.
60 * <p>
61 * Using this filter is recommended instead of filtering the entries using
62 * {@link org.eclipse.jgit.treewalk.TreeWalk#getPathString()} and
63 * <code>endsWith</code> or some other type of string match function.
64 */
65 public class PathSuffixFilter extends TreeFilter {
66
67 /**
68 * Create a new tree filter for a user supplied path suffix.
69 * <p>
70 * Path strings use '/' to delimit directories on all platforms.
71 *
72 * @param path
73 * the path suffix to filter on. Must not be the empty string.
74 * @return a new filter for the requested path.
75 * @throws java.lang.IllegalArgumentException
76 * the path supplied was the empty string.
77 */
78 public static PathSuffixFilter create(String path) {
79 if (path.length() == 0)
80 throw new IllegalArgumentException(JGitText.get().emptyPathNotPermitted);
81 return new PathSuffixFilter(path);
82 }
83
84 final String pathStr;
85 final byte[] pathRaw;
86
87 private PathSuffixFilter(String s) {
88 pathStr = s;
89 pathRaw = Constants.encode(pathStr);
90 }
91
92 /** {@inheritDoc} */
93 @Override
94 public TreeFilter clone() {
95 return this;
96 }
97
98 /** {@inheritDoc} */
99 @Override
100 public boolean include(TreeWalk walker) throws MissingObjectException,
101 IncorrectObjectTypeException, IOException {
102 if (walker.isSubtree())
103 return true;
104 else
105 return walker.isPathSuffix(pathRaw, pathRaw.length);
106
107 }
108
109 /** {@inheritDoc} */
110 @Override
111 public boolean shouldBeRecursive() {
112 return true;
113 }
114
115 }