1 package org.apache.maven.tools.plugin.generator;
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.tools.plugin.PluginToolsRequest;
23
24 import java.io.File;
25
26 /**
27 * Generate something, for instance a plugin report, from a plugin descriptor.
28 *
29 * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
30 * @version $Id: Generator.html 1024032 2018-01-19 18:16:30Z hboutemy $
31 */
32 public interface Generator
33 {
34
35 /**
36 * Execute the generation for a given plugin descriptor.
37 *
38 * @param destinationDirectory required
39 * @param request required
40 * @throws GeneratorException if any
41 *
42 * @since 2.5
43 */
44 void execute( File destinationDirectory, PluginToolsRequest request )
45 throws GeneratorException;
46 }