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.UUID;
22
23 import org.apache.commons.lang3.StringUtils;
24 import org.apache.rat.analysis.IHeaderMatcher;
25 import org.apache.rat.config.parameters.ComponentType;
26 import org.apache.rat.config.parameters.ConfigComponent;
27
28 /**
29 * An abstract class to simplify IHeaderMatcher creation.
30 * This class ensures that the id is set.
31 */
32 public abstract class AbstractHeaderMatcher implements IHeaderMatcher {
33 /**
34 * The id for this matcher. IDs must be unique.
35 */
36 @ConfigComponent(type = ComponentType.PARAMETER, desc = "The id of the matcher.")
37 private final String id;
38
39 /**
40 * Constructs the IHeaderMatcher with an id value. If {@code id} is null then a
41 * unique random id is created.
42 *
43 * @param id the id to use.
44 */
45 protected AbstractHeaderMatcher(final String id) {
46 this.id = StringUtils.isBlank(id) ? UUID.randomUUID().toString() : id;
47 }
48
49 @Override
50 public String getId() {
51 return id;
52 }
53
54 @Override
55 public String toString() {
56 return getId();
57 }
58 }