1 package org.codehaus.mojo.macker;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.plugin.MojoExecutionException;
23 import org.apache.maven.plugin.MojoFailureException;
24
25 import java.io.File;
26 import java.io.IOException;
27
28 /**
29 * Abstraction of the Macker tool. There is a linked and a forked implementation.
30 * @author <a href="http://www.code-cop.org/">Peter Kofler</a>
31 */
32 public interface Macker
33 {
34
35 /**
36 * Add a class to be checked by Macker.
37 * @throws IOException if there's a problem reading a file
38 * @throws MojoExecutionException if there's a problem parsing a class
39 */
40 void addClass( File clazz )
41 throws IOException, MojoExecutionException;
42
43 /**
44 * Add a rule file to be used by Macker.
45 * @throws IOException if there's a problem reading a file
46 * @throws MojoExecutionException if there's a problem parsing a rule file
47 */
48 void addRulesFile( File rule )
49 throws IOException, MojoExecutionException;
50
51 void check()
52 throws MojoExecutionException, MojoFailureException;
53
54 void setAngerThreshold( String anger );
55
56 void setPrintMaxMessages( int maxMsg );
57
58 void setPrintThreshold( String print );
59
60 void setVariable( String name, String value );
61
62 void setVerbose( boolean verbose );
63
64 /**
65 * Set the XML report file to be used by Macker.
66 * @throws IOException if there's a problem with the report file
67 */
68 void setXmlReportFile( File report )
69 throws IOException;
70
71 }