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.configuration.builders;
20
21 import org.apache.rat.analysis.matchers.CopyrightMatcher;
22 import org.apache.rat.config.parameters.MatcherBuilder;
23
24 /**
25 * A copyright builder.
26 */
27 @MatcherBuilder(CopyrightMatcher.class)
28 public class CopyrightBuilder extends AbstractBuilder {
29 /** The start date of the copyright. May be {@code null}. */
30 private String start;
31 /** The end date of the copyright. May be {@code null}. */
32 private String end;
33 /** The owner of the copyright. May be {@code null}. */
34 private String owner;
35
36 /**
37 * Sets the start date.
38 * @param start the start date for the copyright
39 * @return this for chaining
40 */
41 public CopyrightBuilder setStart(final String start) {
42 this.start = start;
43 return this;
44 }
45
46 /**
47 * Sets the end date.
48 * @param end the End data for the copyright.
49 * @return this for chaining.
50 */
51 public CopyrightBuilder setEnd(final String end) {
52 this.end = end;
53 return this;
54 }
55
56 /**
57 * Sets the owner.
58 * @param owner the owner for the copyright
59 * @return this for chaining.
60 */
61 public CopyrightBuilder setOwner(final String owner) {
62 this.owner = owner;
63 return this;
64 }
65
66 @Override
67 public CopyrightMatcher build() {
68 return new CopyrightMatcher(getId(), start, end, owner);
69 }
70
71 @Override
72 public String toString() {
73 return String.format("Copyright Builder: s:%s e:%s o:%s", start, end, owner);
74 }
75 }