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