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.plugins.pmd;
20
21 import org.apache.maven.plugins.annotations.Execute;
22 import org.apache.maven.plugins.annotations.LifecyclePhase;
23 import org.apache.maven.plugins.annotations.Mojo;
24 import org.apache.maven.plugins.annotations.ResolutionScope;
25
26 /**
27 * Creates a PMD site report in an <b>aggregator</b> project based on the rulesets and configuration set in the plugin.
28 * It can also generate a pmd output file aside from the site report in any of the following formats: xml, csv or txt.
29 *
30 * @since 3.15.0
31 */
32 @Mojo(name = "aggregate-pmd", aggregator = true, threadSafe = true, requiresDependencyResolution = ResolutionScope.TEST)
33 @Execute(phase = LifecyclePhase.TEST_COMPILE)
34 public class AggregatorPmdReport extends PmdReport {
35 @Override
36 protected boolean isAggregator() {
37 return true;
38 }
39 }