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