1 package org.apache.maven.plugins.checkstyle.exec;
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 com.puppycrawl.tools.checkstyle.api.CheckstyleException;
23 import com.puppycrawl.tools.checkstyle.api.Configuration;
24
25 /**
26 * @author Olivier Lamy
27 * @since 2.5
28 *
29 */
30 public interface CheckstyleExecutor
31 {
32
33 /**
34 * @param request {@link CheckstyleExecutorRequest}
35 * @return {@link CheckstyleResults}
36 * @throws CheckstyleExecutorException in case of an error during plugin execution.
37 * @throws CheckstyleException in case of an error raised by Checkstyle.
38 */
39 CheckstyleResults executeCheckstyle( CheckstyleExecutorRequest request )
40 throws CheckstyleExecutorException, CheckstyleException;
41
42 Configuration getConfiguration( CheckstyleExecutorRequest request )
43 throws CheckstyleExecutorException;
44 }