1 /*
2 * Copyright (C) 2014, Andrey Loskutov <loskutov@gmx.de>
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.ignore.internal;
44
45 /**
46 * Generic string matcher
47 *
48 * @since 3.6
49 */
50 public interface IMatcher {
51
52 /**
53 * Matcher that does not match any pattern.
54 */
55 public static final IMatcher NO_MATCH = new IMatcher() {
56 public boolean matches(String path, boolean assumeDirectory) {
57 return false;
58 }
59
60 public boolean matches(String segment, int startIncl, int endExcl,
61 boolean assumeDirectory) {
62 return false;
63 }
64 };
65
66 /**
67 * Matches entire given string
68 *
69 * @param path
70 * string which is not null, but might be empty
71 * @param assumeDirectory
72 * true to assume this path as directory (even if it doesn't end
73 * with a slash)
74 * @return true if this matcher pattern matches given string
75 */
76 boolean matches(String path, boolean assumeDirectory);
77
78 /**
79 * Matches only part of given string
80 *
81 * @param segment
82 * string which is not null, but might be empty
83 * @param startIncl
84 * start index, inclusive
85 * @param endExcl
86 * end index, exclusive
87 * @param assumeDirectory
88 * true to assume this path as directory (even if it doesn't end
89 * with a slash)
90 * @return true if this matcher pattern matches given string
91 */
92 boolean matches(String segment, int startIncl, int endExcl,
93 boolean assumeDirectory);
94 }