1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://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 package org.apache.commons.configuration2.tree;
18
19 import org.apache.commons.lang3.Strings;
20
21 /**
22 * Enumerates {@link NodeMatcher} implementations based on node names.
23 * <p>
24 * Filtering nodes by their name is a typical use case. Therefore, some default implementations for typical filter
25 * algorithms are already provided. They are available as constants of this class. Because the algorithms are state-less
26 * these instances can be shared and accessed concurrently.
27 * </p>
28 *
29 * @since 2.0
30 */
31 public enum NodeNameMatchers implements NodeMatcher<String> {
32
33 /**
34 * A matcher for exact node name matches. This matcher returns <strong>true</strong> if and only if the name of the passed in node
35 * equals exactly the given criterion string.
36 */
37 EQUALS {
38 @Override
39 public <T> boolean matches(final T node, final NodeHandler<T> handler, final String criterion) {
40 return Strings.CS.equals(criterion, handler.nodeName(node));
41 }
42 },
43
44 /**
45 * A matcher for matches on node names which ignores case. For this matcher the names {@code node}, {@code NODE}, or
46 * {@code NodE} are all the same.
47 */
48 EQUALS_IGNORE_CASE {
49 @Override
50 public <T> boolean matches(final T node, final NodeHandler<T> handler, final String criterion) {
51 return Strings.CI.equals(criterion, handler.nodeName(node));
52 }
53 }
54 }