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.maven.surefire.extensions;
20
21 import org.apache.maven.surefire.api.report.TestSetReportEntry;
22
23 import static org.apache.maven.surefire.shared.utils.StringUtils.isBlank;
24
25 /**
26 * Extension for stateless reporter.
27 * Signatures can be changed between major, minor versions or milestones.
28 *
29 * @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
30 * @since 3.0.0-M4
31 * @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
32 * @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
33 * @param <C> mojo config, see <em>DefaultStatelessReportMojoConfiguration</em> from <em>maven-surefire-common</em>
34 */
35 public abstract class StatelessReporter<R extends TestSetReportEntry, S, C extends StatelessReportMojoConfiguration> {
36 /**
37 * {@code false} by default
38 */
39 // todo remove isDisableXmlReport() in AbstractSurefireMojo and use this param instead
40 private boolean disable;
41
42 /**
43 * Version of reporter. It is version <em>3.0</em> used by default in XML reporter.
44 */
45 private String version;
46
47 /**
48 * Creates reporter.
49 *
50 * @return reporter object
51 */
52 public abstract StatelessReportEventListener<R, S> createListener(C configuration);
53
54 public abstract Object clone(ClassLoader target);
55
56 public boolean isDisable() {
57 return disable;
58 }
59
60 public void setDisable(boolean disable) {
61 this.disable = disable;
62 }
63
64 public String getVersion() {
65 return isBlank(version) ? "3.0" : version;
66 }
67
68 public void setVersion(String version) {
69 this.version = version;
70 }
71
72 @Override
73 public String toString() {
74 return getClass().getSimpleName() + "{" + "version=" + getVersion() + ", disable=" + isDisable() + '}';
75 }
76 }