1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.analysis.matchers;
20
21 import java.util.Collection;
22
23 import org.apache.rat.analysis.IHeaderMatcher;
24 import org.apache.rat.analysis.IHeaders;
25 import org.apache.rat.config.parameters.ComponentType;
26 import org.apache.rat.config.parameters.ConfigComponent;
27
28 /**
29 * A matcher that performs a logical {@code OR} across all the contained matchers.
30 */
31 @ConfigComponent(type = ComponentType.MATCHER, name = "any", desc = "Returns true if at least one of the enclosed matchers returns true.")
32 public class OrMatcher extends AbstractMatcherContainer {
33
34 /**
35 * Constructs the matcher from the enclosed matchers.
36 *
37 * @param enclosed the enclosed matchers.
38 * @param resource the name of the resource if the collection of matchers was read from a file or resource. May be {@code null}.
39 */
40 public OrMatcher(final Collection<? extends IHeaderMatcher> enclosed, final String resource) {
41 this(null, enclosed, resource);
42 }
43
44 /**
45 * Constructs the matcher with the specified id from the enclosed matchers.
46 *
47 * @param id the id to use.
48 * @param enclosed the enclosed matchers.
49 * @param resource the name of the resource if the collection of matchers was read from a file or resource. May be {@code null}.
50 */
51 public OrMatcher(final String id, final Collection<? extends IHeaderMatcher> enclosed, final String resource) {
52 super(id, enclosed, resource);
53 }
54
55 @Override
56 public boolean matches(final IHeaders headers) {
57 for (IHeaderMatcher matcher : getEnclosed()) {
58 if (matcher.matches(headers)) {
59 return true;
60 }
61 }
62 return false;
63 }
64 }