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.ArrayList;
22 import java.util.Collection;
23 import java.util.Objects;
24
25 import org.apache.rat.analysis.IHeaderMatcher;
26
27 /**
28 * A class that implements IHeaderMatcher as a collection of other IHeaderMatchers.
29 */
30 public abstract class AbstractMatcherContainer extends AbstractHeaderMatcher {
31
32 protected final Collection<IHeaderMatcher> enclosed;
33
34 /**
35 * Constructs the abstract matcher container.
36 * If the {@code id} is not set then a unique random identifier is created.
37 * The {@code enclosed} collection is preserved in a new collection that retains the order of
38 * of the original collection.
39 * @param id The id for the matcher.
40 * @param enclosed the collection of enclosed matchers.
41 */
42 public AbstractMatcherContainer(String id, Collection<? extends IHeaderMatcher> enclosed) {
43 super(id);
44 Objects.requireNonNull(enclosed, "The collection of IHeaderMatcher may not be null");
45 this.enclosed = new ArrayList<>(enclosed);
46 }
47
48 /**
49 * Constructs the abstract matcher container with a unique random id.
50 * The {@code enclosed} collection is preserved in a new collection that retains the order of
51 * of the original collection.
52 * @param enclosed the collection of enclosed matchers.
53 */
54 public AbstractMatcherContainer(Collection<? extends IHeaderMatcher> enclosed) {
55 this(null, enclosed);
56 }
57
58 @Override
59 public void reset() {
60 enclosed.forEach(IHeaderMatcher::reset);
61 }
62
63 @Override
64 public State finalizeState() {
65 enclosed.forEach(IHeaderMatcher::finalizeState);
66 return currentState();
67 }
68 }