| ------ |
| Violation Exclusions |
| ------ |
| 2013-02-08 |
| ------ |
| |
| ~~ Licensed to the Apache Software Foundation (ASF) under one |
| ~~ or more contributor license agreements. See the NOTICE file |
| ~~ distributed with this work for additional information |
| ~~ regarding copyright ownership. The ASF licenses this file |
| ~~ to you under the Apache License, Version 2.0 (the |
| ~~ "License"); you may not use this file except in compliance |
| ~~ with the License. You may obtain a copy of the License at |
| ~~ |
| ~~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~~ |
| ~~ Unless required by applicable law or agreed to in writing, |
| ~~ software distributed under the License is distributed on an |
| ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~~ KIND, either express or implied. See the License for the |
| ~~ specific language governing permissions and limitations |
| ~~ under the License. |
| |
| ~~ NOTE: For help with the syntax of this file, see: |
| ~~ http://maven.apache.org/doxia/references/apt-format.html |
| |
| Violation Exclusions |
| |
| It is possible to exclude some sources from PMD/CPD check to prevent failures. |
| |
| +-----+ |
| <project> |
| ... |
| <build> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.maven.plugins</groupId> |
| <artifactId>maven-pmd-plugin</artifactId> |
| <version>${project.version}</version> |
| <executions> |
| <execution> |
| <goals> |
| <goal>check</goal> |
| </goals> |
| <configuration> |
| <excludeFromFailureFile>exclude-pmd.properties</excludeFromFailureFile> |
| </configuration> |
| </execution> |
| <execution> |
| <goals> |
| <goal>cpd-check</goal> |
| </goals> |
| <configuration> |
| <excludeFromFailureFile>exclude-cpd.properties</excludeFromFailureFile> |
| </configuration> |
| </execution> |
| </executions> |
| </plugin> |
| </plugins> |
| </build> |
| ... |
| </project> |
| +-----+ |
| |
| For cpd check, you can exclude classes to not verify. The properties file must have the following format: |
| |
| The differences here are that: |
| [[1]] org.apache.maven.ClassA and org.apache.maven.ClassB contain duplicated code across classes. |
| [[2]] org.apache.maven.ClassC and org.apache.maven.ClassD do not share duplicate code, but have duplicated code internally. |
| |
| +-----+ |
| org.apache.maven.ClassA,org.apache.maven.ClassB |
| org.apache.maven.ClassC |
| org.apache.maven.ClassD |
| +-----+ |
| |
| For pmd check, you can exclude rules per classes. The properties file must have the following format: |
| |
| +-----+ |
| org.apache.maven.ClassA=UnusedPrivateField,EmptyCatchBlock |
| org.apache.maven.ClassB=UnusedPrivateField,UnusedFormalParameter,UnusedPrivateMethod |
| +-----+ |
| |