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 AND} across all the contained
30 * matchers.
31 */
32 @ConfigComponent(type = ComponentType.MATCHER, name = "all", desc = "Returns true if all enclosed matchers return true.")
33 public class AndMatcher extends AbstractMatcherContainer {
34
35 /**
36 * Constructs the AndMatcher with the specified id and enclosed collection.
37 *
38 * @param id the to use. If null or an empty string a unique random id will be
39 * created.
40 * @param enclosed the enclosed collection.
41 * @param resource the name of the resource the collection was read from if any. May be null.
42 */
43 public AndMatcher(final String id, final Collection<? extends IHeaderMatcher> enclosed, final String resource) {
44 super(id, enclosed, resource);
45 }
46
47 /**
48 * Constructs the AndMatcher with an unique random id and the enclosed
49 * collection.
50 *
51 * @param enclosed the enclosed collection.
52 * @param resource the name of the resource the collection was read from if any. May be null.
53 */
54 public AndMatcher(final Collection<? extends IHeaderMatcher> enclosed, final String resource) {
55 this(null, enclosed, resource);
56 }
57
58 @Override
59 public boolean matches(final IHeaders headers) {
60 for (IHeaderMatcher matcher : getEnclosed()) {
61 if (!matcher.matches(headers)) {
62 return false;
63 }
64 }
65 return true;
66 }
67 }