View Javadoc

1   package org.apache.maven.plugin.checkstyle;
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  
24  /**
25   * @author Olivier Lamy
26   * @since 2.5
27   * @version $Id: CheckstyleExecutor.java 1387920 2012-09-20 09:08:27Z olamy $
28   */
29  public interface CheckstyleExecutor
30  {
31  
32      /**
33       * @param {@link CheckstyleExecutorRequest}
34       * @return {@link CheckstyleResults}
35       * @throws CheckstyleExecutorException
36       * @throws CheckstyleException
37       */
38      CheckstyleResults executeCheckstyle( CheckstyleExecutorRequest request )
39          throws CheckstyleExecutorException, CheckstyleException;
40  }