01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18: package org.apache.ivy.plugins.matcher;
19:
20: /**
21: * Interface for a pattern matcher. <p/> The pattern matcher is the main abstraction regarding the
22: * matching of an expression. Implementation may vary depending on the expression syntax handling
23: * that is desired.
24: */
25: public interface PatternMatcher {
26:
27: /**
28: * 'exact' pattern matcher name
29: */
30: public static final String EXACT = "exact";
31:
32: /**
33: * pattern matcher name 'regexp'
34: */
35: public static final String REGEXP = "regexp";
36:
37: /**
38: * pattern matcher 'glob'
39: */
40: public static final String GLOB = "glob";
41:
42: /**
43: * pattern matcher name 'exactOrRegexp'
44: */
45: public static final String EXACT_OR_REGEXP = "exactOrRegexp";
46:
47: /**
48: * Any expression string: '*'
49: */
50: public static final String ANY_EXPRESSION = "*";
51:
52: /**
53: * Return the matcher for the given expression.
54: *
55: * @param expression
56: * the expression to be matched. Cannot be null ?
57: * @return the matcher instance for the given expression. Never null.
58: */
59: public/* @NotNull */Matcher getMatcher(
60: /* @NotNull */String expression);
61:
62: /**
63: * return the name of this pattern matcher
64: *
65: * @return the name of this pattern matcher. Never null.
66: * @see #EXACT
67: * @see #REGEXP
68: * @see #GLOB
69: * @see #EXACT_OR_REGEXP
70: */
71: public/* @NotNull */String getName();
72: }
|