001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.tools.plugin.generator;
020
021import java.io.File;
022
023import org.apache.maven.tools.plugin.PluginToolsRequest;
024
025/**
026 * Generate something, for instance a plugin report, from a plugin descriptor.
027 *
028 * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
029 */
030public interface Generator {
031
032    /**
033     * Execute the generation for a given plugin descriptor.
034     *
035     * @param destinationDirectory required
036     * @param request required
037     * @throws GeneratorException if any
038     *
039     * @since 2.5
040     */
041    void execute(File destinationDirectory, PluginToolsRequest request) throws GeneratorException;
042}